blob: 428fe87aee769517fd65b9109d76d03ee0a82451 [file] [log] [blame]
Harald Welte52b1f982008-12-23 20:25:15 +00001#ifndef _GSM_DATA_H
2#define _GSM_DATA_H
3
Harald Weltef142c972011-05-24 13:25:38 +02004#include <stdint.h>
Maxddee01f2016-05-24 14:23:27 +02005#include <sys/types.h>
Maxe6052c42016-06-30 10:25:49 +02006#include <stdbool.h>
Harald Weltef142c972011-05-24 13:25:38 +02007
8#include <osmocom/core/timer.h>
Alexander Couzens20423ea2016-07-12 15:42:02 +02009#include <osmocom/core/rate_ctr.h>
Harald Welte6be350c2011-05-25 13:10:08 +020010#include <osmocom/core/select.h>
Alexander Couzens2f9df962020-09-21 18:35:24 +020011#include <osmocom/core/socket.h>
Alexander Couzens20423ea2016-07-12 15:42:02 +020012#include <osmocom/core/stats.h>
Stefan Sperling81dc9e72018-02-05 17:34:36 +010013#include <osmocom/core/stat_item.h>
Philipp Maier8c498fc2018-02-21 13:24:36 +010014#include <osmocom/gsm/bts_features.h>
Neels Hofmeyra60f3442018-02-12 16:44:32 +010015#include <osmocom/gsm/protocol/gsm_08_08.h>
Harald Welted41b7c72019-06-13 09:41:58 +020016#include <osmocom/gsm/protocol/gsm_48_049.h>
Neels Hofmeyr31f525e2018-05-14 18:14:15 +020017#include <osmocom/gsm/gsm0808.h>
Neels Hofmeyrf93970b2018-03-05 02:09:40 +010018#include <osmocom/gsm/gsm48.h>
Harald Welte3561bd42018-01-28 03:04:16 +010019#include <osmocom/core/fsm.h>
Neels Hofmeyra6078fe2019-01-28 03:52:14 +010020#include <osmocom/core/tdef.h>
Alexander Couzens20423ea2016-07-12 15:42:02 +020021
Harald Welte121e9a42016-04-20 13:13:19 +020022#include <osmocom/crypt/auth.h>
Harald Weltef142c972011-05-24 13:25:38 +020023
Neels Hofmeyrc0164792017-09-04 15:15:32 +020024#include <osmocom/bsc/rest_octets.h>
Harald Welteb96be392011-05-25 12:33:33 +020025
Neels Hofmeyr10485162018-02-13 23:22:03 +010026#include <osmocom/core/bitvec.h>
27#include <osmocom/gsm/gsm_utils.h>
28#include <osmocom/gsm/rxlev_stat.h>
29#include <osmocom/gsm/protocol/gsm_08_58.h>
30#include <osmocom/gsm/protocol/gsm_12_21.h>
31#include <osmocom/abis/e1_input.h>
32#include <osmocom/bsc/meas_rep.h>
Pau Espin Pedrol02f20562020-07-20 16:21:54 +020033#include <osmocom/bsc/acc.h>
Neels Hofmeyr31f525e2018-05-14 18:14:15 +020034#include <osmocom/bsc/neighbor_ident.h>
Pau Espin Pedrol83c0f762019-04-16 20:05:32 +020035#include <osmocom/bsc/osmux.h>
Neels Hofmeyr10485162018-02-13 23:22:03 +010036
Neels Hofmeyr596c4022018-06-16 19:29:50 +020037#define GSM_T3122_DEFAULT 10
38
Harald Welte74b8cdb2018-01-15 19:26:06 +010039struct mgcp_client_conf;
40struct mgcp_client;
Neels Hofmeyr19bed232018-03-22 04:54:57 +010041struct gsm0808_cell_id;
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +020042struct osmo_mgcpc_ep;
Pau Espin Pedrol388ed582020-07-15 20:53:16 +020043struct gsm_bts;
Pau Espin Pedrolaca53202020-07-16 14:49:36 +020044struct gsm_bts_trx;
Philipp Maier39f62bb2017-04-09 12:32:51 +020045
Holger Hans Peter Freytherd7b22c62013-04-29 09:11:02 +020046/** annotations for msgb ownership */
47#define __uses
48
Holger Hans Peter Freyther6f615552010-11-15 20:50:42 +010049#define OBSC_NM_W_ACK_CB(__msgb) (__msgb)->cb[3]
50
Neels Hofmeyr6d804b12017-02-18 22:20:46 +010051struct bsc_subscr;
Neels Hofmeyr7b656882017-07-09 22:09:18 +020052struct gprs_ra_id;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +020053struct handover;
Neels Hofmeyra33ef3a2020-10-01 04:23:32 +020054struct osmo_sccp_instance;
Neels Hofmeyr4ae338d2020-09-17 17:54:39 +020055struct smlc_config;
Holger Hans Peter Freyther694c82d2011-10-26 18:37:09 +020056
Holger Hans Peter Freyther9c595b72010-06-15 11:20:52 +080057#define OBSC_LINKID_CB(__msgb) (__msgb)->cb[3]
58
Max70fdd242017-06-15 15:10:53 +020059/* 3-bit long values */
60#define EARFCN_PRIO_INVALID 8
61#define EARFCN_MEAS_BW_INVALID 8
62/* 5-bit long values */
63#define EARFCN_QRXLV_INVALID 32
64#define EARFCN_THRESH_LOW_INVALID 32
65
Harald Welte8e1e3ee2009-02-01 13:32:45 +000066struct msgb;
67typedef int gsm_cbfn(unsigned int hooknum,
68 unsigned int event,
69 struct msgb *msg,
70 void *data, void *param);
71
Harald Weltef7c28b02009-12-21 13:30:17 +010072/* Maximum number of neighbor cells whose average we track */
73#define MAX_NEIGH_MEAS 10
74/* Maximum size of the averaging window for neighbor cells */
75#define MAX_WIN_NEIGH_AVG 10
Andreas Eversberg98692032013-06-23 10:44:34 +020076/* Maximum number of report history we store */
77#define MAX_MEAS_REP 10
Harald Weltef7c28b02009-12-21 13:30:17 +010078
79/* processed neighbor measurements for one cell */
80struct neigh_meas_proc {
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +020081 uint16_t arfcn;
82 uint8_t bsic;
83 uint8_t rxlev[MAX_WIN_NEIGH_AVG];
Harald Weltef7c28b02009-12-21 13:30:17 +010084 unsigned int rxlev_cnt;
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +020085 uint8_t last_seen_nr;
Harald Weltef7c28b02009-12-21 13:30:17 +010086};
87
Harald Weltea43e0b42016-06-19 18:06:02 +020088struct gsm_classmark {
89 bool classmark1_set;
90 struct gsm48_classmark1 classmark1;
91 uint8_t classmark2_len;
92 uint8_t classmark2[3];
93 uint8_t classmark3_len;
94 uint8_t classmark3[14]; /* if cm3 gets extended by spec, it will be truncated */
95};
96
Harald Welte519c7e12018-01-28 02:45:46 +010097enum subscr_sccp_state {
98 SUBSCR_SCCP_ST_NONE,
99 SUBSCR_SCCP_ST_WAIT_CONN_CONF,
100 SUBSCR_SCCP_ST_CONNECTED
101};
102
Sylvain Munautaa824922019-03-07 16:32:02 +0100103enum channel_rate {
104 CH_RATE_SDCCH,
105 CH_RATE_HALF,
106 CH_RATE_FULL,
107};
108
Philipp Maierbb66d102019-01-22 11:29:06 +0100109struct channel_mode_and_rate {
110 enum gsm48_chan_mode chan_mode;
Sylvain Munautaa824922019-03-07 16:32:02 +0100111 enum channel_rate chan_rate;
Philipp Maierbb66d102019-01-22 11:29:06 +0100112 uint16_t s15_s0;
113};
114
Neels Hofmeyr7cfdbe72019-02-06 01:30:19 +0100115/* Information retrieved during an Assignment Request from the MSC. This is storage of the Assignment instructions
116 * parsed from the Assignment Request message, to pass on until the gscon and assignment FSMs have decided whether an
117 * Assignment is actually going to be carried out. Should remain unchanged after initial decoding. */
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200118struct assignment_request {
119 bool aoip;
120
121 uint16_t msc_assigned_cic;
122
Pau Espin Pedrol657f3102020-08-28 18:35:22 +0200123 char msc_rtp_addr[INET6_ADDRSTRLEN];
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200124 uint16_t msc_rtp_port;
Pau Espin Pedrol83c0f762019-04-16 20:05:32 +0200125 bool use_osmux;
126 uint8_t osmux_cid;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200127
Sylvain Munautaa824922019-03-07 16:32:02 +0100128 /* Rate/codec setting in preference order (need at least 1 !) */
129 int n_ch_mode_rate;
130 struct channel_mode_and_rate ch_mode_rate[3];
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200131};
132
Neels Hofmeyr7cfdbe72019-02-06 01:30:19 +0100133/* State of an ongoing Assignment, while the assignment_fsm is still busy. This serves as state separation to keep the
134 * currently used lchan and gscon unmodified until the outcome of an Assignment is known. If the Assignment fails, this
135 * state is simply discarded, and the gscon carries on with the original lchan remaining unchanged. */
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200136struct assignment_fsm_data {
137 struct assignment_request req;
138 bool requires_voice_stream;
139
140 struct osmo_fsm_inst *fi;
141 struct gsm_lchan *new_lchan;
142
143 /* Whether this assignment triggered creation of the MGW endpoint: if the assignment
144 * fails, we will release that again as soon as possible. (If false, the endpoint already
145 * existed before or isn't needed at all.)*/
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +0200146 struct osmo_mgcpc_ep_ci *created_ci_for_msc;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200147
148 enum gsm0808_cause failure_cause;
149 enum gsm48_rr_cause rr_cause;
150
151 bool result_rate_ctr_done;
152};
153
154enum hodec_id {
155 HODEC_NONE,
156 HODEC1 = 1,
157 HODEC2 = 2,
158 HODEC_USER,
159 HODEC_REMOTE,
160};
161
162/* For example, to count specific kinds of ongoing handovers, it is useful to be able to OR-combine
163 * scopes. */
164enum handover_scope {
165 HO_NO_HANDOVER = 0,
166 HO_INTRA_CELL = 0x1,
167 HO_INTRA_BSC = 0x2,
168 HO_INTER_BSC_OUT = 0x4,
169 HO_INTER_BSC_IN = 0x8,
170 HO_SCOPE_ALL = 0xffff,
171};
172
173extern const struct value_string handover_scope_names[];
174inline static const char *handover_scope_name(enum handover_scope val)
175{ return get_value_string(handover_scope_names, val); }
176
177struct handover_out_req {
178 enum hodec_id from_hodec_id;
179 struct gsm_lchan *old_lchan;
180 struct neighbor_ident_key target_nik;
181 enum gsm_chan_t new_lchan_type; /*< leave GSM_LCHAN_NONE to use same as old_lchan */
182};
183
184struct handover_in_req {
185 struct gsm0808_channel_type ct;
186 struct gsm0808_speech_codec_list scl;
187 struct gsm0808_encrypt_info ei;
188 struct gsm_classmark classmark;
Neels Hofmeyrc15f6cd2019-03-15 02:48:39 +0100189 /* chosen_encr_alg reflects the encoded value as in RSL_ENC_ALG_A5(a5_numer):
190 * chosen_encr_alg == 1 means A5/0 i.e. no encryption, chosen_encr_alg == 4 means A5/3.
191 * chosen_encr_alg == 0 means no such IE was present. */
192 uint8_t chosen_encr_alg;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200193 struct gsm0808_cell_id cell_id_serving;
194 char cell_id_serving_name[64];
195 struct gsm0808_cell_id cell_id_target;
196 char cell_id_target_name[64];
197 uint16_t msc_assigned_cic;
Pau Espin Pedrol657f3102020-08-28 18:35:22 +0200198 char msc_assigned_rtp_addr[INET6_ADDRSTRLEN];
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200199 uint16_t msc_assigned_rtp_port;
200};
201
202struct handover {
203 struct osmo_fsm_inst *fi;
204
205 enum hodec_id from_hodec_id;
206 enum handover_scope scope;
207 enum gsm_chan_t new_lchan_type;
208 struct neighbor_ident_key target_cell;
209
210 uint8_t ho_ref;
211 struct gsm_bts *new_bts;
212 struct gsm_lchan *new_lchan;
213 bool async;
214 struct handover_in_req inter_bsc_in;
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +0200215 struct osmo_mgcpc_ep_ci *created_ci_for_msc;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200216};
217
Neels Hofmeyr378a4922016-05-09 21:07:43 +0200218/* active radio connection of a mobile subscriber */
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100219struct gsm_subscriber_connection {
Harald Weltea43e0b42016-06-19 18:06:02 +0200220 /* global linked list of subscriber_connections */
Holger Hans Peter Freyther79f763f2010-09-16 00:53:37 +0800221 struct llist_head entry;
222
Harald Welte3561bd42018-01-28 03:04:16 +0100223 /* FSM instance to control the subscriber connection state (RTP, A) */
224 struct osmo_fsm_inst *fi;
225
Harald Weltea43e0b42016-06-19 18:06:02 +0200226 /* libbsc subscriber information (if available) */
Neels Hofmeyr6d804b12017-02-18 22:20:46 +0100227 struct bsc_subscr *bsub;
228
Holger Hans Peter Freyther18b63f42010-03-23 07:52:17 +0100229 /* back pointers */
Neels Hofmeyr5e0b0a62016-05-09 22:33:01 +0200230 struct gsm_network *network;
231
Neels Hofmeyr7cfdbe72019-02-06 01:30:19 +0100232 /* the primary / currently active lchan to the BTS/subscriber. During Assignment and Handover, separate lchans
233 * are kept in the .assignment or .handover sub-structs, respectively, so that this lchan remains unaffected
234 * until Assignment or Handover have actually succeeded. */
Harald Welte4a8ebc82017-12-18 18:34:41 +0100235 struct gsm_lchan *lchan;
Harald Welte3561bd42018-01-28 03:04:16 +0100236
Neels Hofmeyr7cfdbe72019-02-06 01:30:19 +0100237 /* Only valid during an ongoing Assignment; might be overwritten at any time by a failed Assignment attempt.
238 * Once an Assignment was successful, all relevant state must be copied out of this sub-struct. */
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200239 struct assignment_fsm_data assignment;
Holger Hans Peter Freyther77cd95d2010-11-14 16:19:48 +0100240
Neels Hofmeyr7cfdbe72019-02-06 01:30:19 +0100241 /* handover information, if a handover is pending for this conn. Valid only during an ongoing Handover
242 * operation. If a Handover was successful, all relevant state must be copied out of this sub-struct. */
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200243 struct handover ho;
Holger Hans Peter Freyther77cd95d2010-11-14 16:19:48 +0100244
Neels Hofmeyr149160f2018-06-16 17:20:13 +0200245 /* Queue DTAP messages during handover/assignment (msgb_enqueue()/msgb_dequeue())*/
246 struct llist_head dtap_queue;
247 unsigned int dtap_queue_len;
Andreas Eversberg084b4212013-05-30 14:12:48 +0200248
Neels Hofmeyrec422642018-02-15 14:07:40 +0100249 struct {
Neels Hofmeyr909e9722017-12-07 03:54:01 +0100250 int failures;
Neels Hofmeyrec422642018-02-15 14:07:40 +0100251 struct penalty_timers *penalty_timers;
252 } hodec2;
Neels Hofmeyra60f3442018-02-12 16:44:32 +0100253
254 /* "Codec List (MSC Preferred)" as received by the BSSAP Assignment Request. 3GPP 48.008
255 * 3.2.2.103 says:
256 * The "Codec List (MSC Preferred)" shall not include codecs
257 * that are not supported by the MS.
258 * i.e. by heeding the "Codec list (MSC Preferred)", we inherently heed the MS bearer
259 * capabilities, which the MSC is required to translate into the codec list. */
260 struct gsm0808_speech_codec_list codec_list;
Harald Welte519c7e12018-01-28 02:45:46 +0100261
262 /* flag to prevent multiple simultaneous ciphering commands */
263 int ciphering_handled;
264
Harald Welte519c7e12018-01-28 02:45:46 +0100265 /* SCCP connection associatd with this subscriber_connection */
266 struct {
Martin Haukea29affd2019-11-13 22:10:41 +0100267 /* SCCP connection related */
Harald Welte519c7e12018-01-28 02:45:46 +0100268 struct bsc_msc_data *msc;
269
270 /* Sigtran connection ID */
271 int conn_id;
272 enum subscr_sccp_state state;
273 } sccp;
274
275 /* for audio handling */
276 struct {
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200277 uint16_t msc_assigned_cic;
Harald Welte519c7e12018-01-28 02:45:46 +0100278
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200279 /* RTP address where the MSC expects us to send the RTP stream coming from the BTS. */
Pau Espin Pedrol657f3102020-08-28 18:35:22 +0200280 char msc_assigned_rtp_addr[INET6_ADDRSTRLEN];
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200281 uint16_t msc_assigned_rtp_port;
Harald Welte519c7e12018-01-28 02:45:46 +0100282
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200283 /* The endpoint at the MGW used to join both BTS and MSC side connections, e.g.
284 * "rtpbridge/23@mgw". */
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +0200285 struct osmo_mgcpc_ep *mgw_endpoint;
Harald Welte3561bd42018-01-28 03:04:16 +0100286
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +0200287 /* The connection identifier of the osmo_mgcpc_ep used to transceive RTP towards the MSC.
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200288 * (The BTS side CI is handled by struct gsm_lchan and the lchan_fsm.) */
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +0200289 struct osmo_mgcpc_ep_ci *mgw_endpoint_ci_msc;
Harald Welte519c7e12018-01-28 02:45:46 +0100290 } user_plane;
Harald Weltec997ceb2018-05-30 01:39:43 +0200291
292 /* LCLS (local call, local switch) related state */
293 struct {
294 uint8_t global_call_ref[15];
295 uint8_t global_call_ref_len; /* length of global_call_ref */
Maxfe65ece2018-11-09 13:36:11 +0100296 enum gsm0808_lcls_config config; /* TS 48.008 3.2.2.116 */
297 enum gsm0808_lcls_control control; /* TS 48.008 3.2.2.117 */
Harald Weltec997ceb2018-05-30 01:39:43 +0200298 /* LCLS FSM */
299 struct osmo_fsm_inst *fi;
300 /* pointer to "other" connection, if Call Leg Relocation was successful */
301 struct gsm_subscriber_connection *other;
302 } lcls;
Pau Espin Pedrol7950e5d2019-10-31 15:59:49 +0100303
304 /* MS Power Class, TS 05.05 sec 4.1.1 "Mobile station". 0 means unset. */
305 uint8_t ms_power_class:3;
Neels Hofmeyr90f7c3c2020-08-29 23:01:44 +0000306
307 bool rx_clear_command;
Neels Hofmeyr4ae338d2020-09-17 17:54:39 +0200308
309 /* Location Services handling for this subscriber */
310 struct {
311 /* FSM to handle Perform Location Request coming in from the MSC via A interface,
312 * and receive BSSMAP-LE responses from the SMLC. */
313 struct lcs_loc_req *loc_req;
314
315 /* FSM to handle BSSLAP requests coming in from the SMLC via Lb interface.
316 * BSSLAP APDU are encapsulated in BSSMAP-LE Connection Oriented Information messages. */
317 struct lcs_bsslap *bsslap;
318
319 /* Lb interface to the SMLC: BSSMAP-LE/SCCP connection associated with this subscriber */
320 struct {
321 int conn_id;
322 enum subscr_sccp_state state;
323 } lb;
324 } lcs;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100325};
326
Harald Weltef142c972011-05-24 13:25:38 +0200327
Neels Hofmeyr10485162018-02-13 23:22:03 +0100328/* 16 is the max. number of SI2quater messages according to 3GPP TS 44.018 Table 10.5.2.33b.1:
329 4-bit index is used (2#1111 = 10#15) */
330#define SI2Q_MAX_NUM 16
331/* length in bits (for single SI2quater message) */
332#define SI2Q_MAX_LEN 160
333#define SI2Q_MIN_LEN 18
334
335struct osmo_bsc_data;
336
337struct osmo_bsc_sccp_con;
338
339/* Channel Request reason */
340enum gsm_chreq_reason_t {
341 GSM_CHREQ_REASON_EMERG,
342 GSM_CHREQ_REASON_PAG,
343 GSM_CHREQ_REASON_CALL,
344 GSM_CHREQ_REASON_LOCATION_UPD,
345 GSM_CHREQ_REASON_OTHER,
346 GSM_CHREQ_REASON_PDCH,
347};
348
349/* lchans 0..3 are SDCCH in combined channel configuration,
350 use 4 as magic number for BCCH hack - see osmo-bts-../oml.c:opstart_compl() */
351#define CCCH_LCHAN 4
352
Neels Hofmeyr10485162018-02-13 23:22:03 +0100353#define TS_MAX_LCHAN 8
354
355#define HARDCODED_ARFCN 123
356#define HARDCODED_BSIC 0x3f /* NCC = 7 / BCC = 7 */
357
358/* for multi-drop config */
359#define HARDCODED_BTS0_TS 1
360#define HARDCODED_BTS1_TS 6
361#define HARDCODED_BTS2_TS 11
362
363#define MAX_VERSION_LENGTH 64
364
Neels Hofmeyr10485162018-02-13 23:22:03 +0100365enum gsm_hooks {
366 GSM_HOOK_NM_SWLOAD,
367 GSM_HOOK_RR_PAGING,
368 GSM_HOOK_RR_SECURITY,
369};
370
Neels Hofmeyr10485162018-02-13 23:22:03 +0100371enum bts_gprs_mode {
372 BTS_GPRS_NONE = 0,
373 BTS_GPRS_GPRS = 1,
374 BTS_GPRS_EGPRS = 2,
375};
376
377struct gsm_lchan;
378struct osmo_rtp_socket;
379struct rtp_socket;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100380
381/* Network Management State */
382struct gsm_nm_state {
383 uint8_t operational;
384 uint8_t administrative;
385 uint8_t availability;
386};
387
388struct gsm_abis_mo {
389 uint8_t obj_class;
390 uint8_t procedure_pending;
391 struct abis_om_obj_inst obj_inst;
392 const char *name;
393 struct gsm_nm_state nm_state;
394 struct tlv_parsed *nm_attr;
395 struct gsm_bts *bts;
Pau Espin Pedrol4338de52020-09-30 12:52:04 +0200396 struct osmo_fsm_inst *fi;
397 bool opstart_sent;
Pau Espin Pedrol6adeb602020-09-30 12:52:53 +0200398 bool adm_unlock_sent;
399 bool set_attr_sent;
400 bool set_attr_ack_received;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100401};
402
403/* Ericsson OM2000 Managed Object */
404struct abis_om2k_mo {
405 uint8_t class;
406 uint8_t bts;
407 uint8_t assoc_so;
408 uint8_t inst;
409} __attribute__ ((packed));
410
411struct om2k_mo {
412 struct abis_om2k_mo addr;
413 struct osmo_fsm_inst *fsm;
414};
415
416#define A38_XOR_MIN_KEY_LEN 12
417#define A38_XOR_MAX_KEY_LEN 16
418#define A38_COMP128_KEY_LEN 16
419#define RSL_ENC_ALG_A5(x) (x+1)
Neels Hofmeyr19ec3742020-07-08 02:58:52 +0200420/* Up to 16 SI2quater are multiplexed; each fits 3 EARFCNS, so the practical maximum is 3*16.
421 * The real maximum that fits in a total of 16 SI2quater rest octets also depends on the bits left by other SI2quater
422 * rest octets elements, so to really fit 48 EARFCNs most other SI2quater elements need to be omitted. */
423#define MAX_EARFCN_LIST (3*16)
Neels Hofmeyr10485162018-02-13 23:22:03 +0100424
425/* is the data link established? who established it? */
426#define LCHAN_SAPI_UNUSED 0
427#define LCHAN_SAPI_MS 1
428#define LCHAN_SAPI_NET 2
Neels Hofmeyr10485162018-02-13 23:22:03 +0100429
430/* BTS ONLY */
431#define MAX_NUM_UL_MEAS 104
432#define LC_UL_M_F_L1_VALID (1 << 0)
433#define LC_UL_M_F_RES_VALID (1 << 1)
434
435struct bts_ul_meas {
436 /* BER in units of 0.01%: 10.000 == 100% ber, 0 == 0% ber */
437 uint16_t ber10k;
438 /* timing advance offset (in quarter bits) */
439 int16_t ta_offs_qbits;
440 /* C/I ratio in dB */
441 float c_i;
442 /* flags */
443 uint8_t is_sub:1;
444 /* RSSI in dBm * -1 */
445 uint8_t inv_rssi;
446};
447
448struct bts_codec_conf {
449 uint8_t hr;
450 uint8_t efr;
451 uint8_t amr;
452};
453
454struct amr_mode {
455 uint8_t mode;
456 uint8_t threshold;
457 uint8_t hysteresis;
458};
459
460struct amr_multirate_conf {
461 uint8_t gsm48_ie[2];
462 struct amr_mode ms_mode[4];
463 struct amr_mode bts_mode[4];
464 uint8_t num_modes;
465};
466/* /BTS ONLY */
467
468enum lchan_csd_mode {
469 LCHAN_CSD_M_NT,
470 LCHAN_CSD_M_T_1200_75,
471 LCHAN_CSD_M_T_600,
472 LCHAN_CSD_M_T_1200,
473 LCHAN_CSD_M_T_2400,
474 LCHAN_CSD_M_T_9600,
475 LCHAN_CSD_M_T_14400,
476 LCHAN_CSD_M_T_29000,
477 LCHAN_CSD_M_T_32000,
478};
479
480/* State of the SAPIs in the lchan */
481enum lchan_sapi_state {
482 LCHAN_SAPI_S_NONE,
483 LCHAN_SAPI_S_REQ,
484 LCHAN_SAPI_S_ASSIGNED,
485 LCHAN_SAPI_S_REL,
486 LCHAN_SAPI_S_ERROR,
487};
488
Neels Hofmeyr92b9f2e2018-02-14 00:19:11 +0100489#define MAX_A5_KEY_LEN (128/8)
490
491struct gsm_encr {
492 uint8_t alg_id;
493 uint8_t key_len;
494 uint8_t key[MAX_A5_KEY_LEN];
495};
496
Neels Hofmeyr8da22332018-04-11 01:43:41 +0200497#define LOGPLCHAN(lchan, ss, level, fmt, args...) \
498 LOGP(ss, level, "%s (ss=%d,%s) (%s) " fmt, \
499 lchan ? gsm_ts_and_pchan_name(lchan->ts) : "-", \
500 lchan ? lchan->nr : 0, \
501 lchan ? gsm_lchant_name(lchan->type) : "-", \
502 bsc_subscr_name(lchan && lchan->conn ? lchan->conn->bsub : NULL), \
503 ## args)
504
Pau Espin Pedrold3e8e0c2018-11-28 16:35:10 +0100505/* Iterate lchans that have an FSM allocated based based on explicit pchan kind
506 * (GSM_PCHAN_* constant).
507 * Remark: PDCH related lchans are not handled in BSC but in PCU, so trying to
508 * iterate through GSM_PCHAN_PDCH is considered a void loop.
509 */
510#define ts_as_pchan_for_each_lchan(lchan, ts, as_pchan) \
511 for (lchan = (ts)->lchan; \
512 ((lchan - (ts)->lchan) < ARRAY_SIZE((ts)->lchan)) \
513 && lchan->fi \
514 && lchan->nr < pchan_subslots(as_pchan); \
515 lchan++)
516
Pau Espin Pedrol7ae0f9c2018-11-28 16:37:37 +0100517/* Iterate lchans that have an FSM allocated based on current PCHAN
518 * mode set in \ref ts.
519 * usage:
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200520 * struct gsm_lchan *lchan;
521 * struct gsm_bts_trx_ts *ts = get_some_timeslot();
522 * ts_for_each_lchan(lchan, ts) {
523 * LOGPLCHAN(DMAIN, LOGL_DEBUG, "hello world\n");
524 * }
Pau Espin Pedrol7ae0f9c2018-11-28 16:37:37 +0100525 */
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200526#define ts_for_each_lchan(lchan, ts) ts_as_pchan_for_each_lchan(lchan, ts, (ts)->pchan_is)
527
Pau Espin Pedrol0ba20df2018-11-28 16:39:29 +0100528/* Iterate over all possible lchans available that have an FSM allocated based
529 * on PCHAN \ref ts (dynamic) configuration.
530 * Iterate all lchan instances set up by this \ref ts type, including those
531 * lchans currently disabled or in process of being enabled (e.g. due to dynamic
532 * timeslot in switchover). Compare ts_for_each_lchan(), which iterates only the
533 * enabled lchans.
534 * For example, it is useful in case dynamic timeslot \ref ts is in process of
535 * switching from configuration PDCH (no lchans) to TCH_F (1 lchan), where
536 * pchan_is is still set to PDCH but \ref ts may contain already an \ref lchan
537 * of type TCH_F which initiated the request to switch the \ts configuration.
538 */
539#define ts_for_each_potential_lchan(lchan, ts) ts_as_pchan_for_each_lchan(lchan, ts, (ts)->pchan_on_init)
540
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200541enum lchan_activate_mode {
542 FOR_NONE,
543 FOR_MS_CHANNEL_REQUEST,
544 FOR_ASSIGNMENT,
545 FOR_HANDOVER,
546 FOR_VTY,
547};
548
549extern const struct value_string lchan_activate_mode_names[];
550static inline const char *lchan_activate_mode_name(enum lchan_activate_mode activ_for)
551{ return get_value_string(lchan_activate_mode_names, activ_for); }
552
Neels Hofmeyr700e5182018-12-19 17:19:02 +0100553struct lchan_activate_info {
554 enum lchan_activate_mode activ_for;
555 struct gsm_subscriber_connection *for_conn;
556 /* This always is for a specific lchan, so its lchan->type indicates full or half rate.
557 * When a dyn TS was selected, the lchan->type has been set to the desired rate. */
558 enum gsm48_chan_mode chan_mode;
Neels Hofmeyr58cf1b12019-03-15 02:49:18 +0100559 struct gsm_encr encr;
Neels Hofmeyr38134ea2018-12-21 03:01:00 +0100560 /* AMR config */
Neels Hofmeyr700e5182018-12-19 17:19:02 +0100561 uint16_t s15_s0;
562 bool requires_voice_stream;
563 bool wait_before_switching_rtp; /*< true = requires LCHAN_EV_READY_TO_SWITCH_RTP */
564 uint16_t msc_assigned_cic;
Neels Hofmeyr38134ea2018-12-21 03:01:00 +0100565 /* During intra-BSC handover, we keep the MGW endpoint intact and just re-route to the new lchan. This
566 * activate_info is for the new lchan, the re_use_mgw_endpoint_from_lchan points at the old lchan. */
Neels Hofmeyr700e5182018-12-19 17:19:02 +0100567 struct gsm_lchan *re_use_mgw_endpoint_from_lchan;
568};
569
Neels Hofmeyr10485162018-02-13 23:22:03 +0100570struct gsm_lchan {
571 /* The TS that we're part of */
572 struct gsm_bts_trx_ts *ts;
573 /* The logical subslot number in the TS */
574 uint8_t nr;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200575 char *name;
576
Neels Hofmeyreee24eb2018-11-06 21:39:15 +0100577 char *last_error;
578
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200579 struct osmo_fsm_inst *fi;
Neels Hofmeyrac85b342018-07-12 21:23:26 +0200580 struct osmo_fsm_inst *fi_rtp;
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +0200581 struct osmo_mgcpc_ep_ci *mgw_endpoint_ci_bts;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200582
583 struct {
Neels Hofmeyr700e5182018-12-19 17:19:02 +0100584 struct lchan_activate_info info;
Neels Hofmeyrac85b342018-07-12 21:23:26 +0200585 bool activ_ack; /*< true as soon as RSL Chan Activ Ack is received */
Neels Hofmeyr369fba22018-11-27 01:30:50 +0100586 bool immediate_assignment_sent;
Neels Hofmeyr193c1e32018-08-27 22:06:24 +0200587 /*! This flag ensures that when an lchan activation has succeeded, and we have already
588 * sent ACKs like Immediate Assignment or BSSMAP Assignment Complete, and if other errors
589 * occur later, e.g. during release, that we don't send a NACK out of context. */
590 bool concluded;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200591 enum gsm0808_cause gsm0808_error_cause;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200592 } activate;
593
Neels Hofmeyreee24eb2018-11-06 21:39:15 +0100594 struct {
595 /* If an event to release the lchan comes in while still waiting for responses, just mark this
596 * flag, so that the lchan will gracefully release at the next sensible junction. */
597 bool requested;
598 bool do_rr_release;
Neels Hofmeyrb523f542020-07-09 15:54:40 +0200599 enum gsm48_rr_cause rr_cause;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200600
Neels Hofmeyreee24eb2018-11-06 21:39:15 +0100601 /* There is an RSL error cause of value 0, so we need a separate flag. */
602 bool in_error;
603 /* RSL error code, RSL_ERR_* */
604 uint8_t rsl_error_cause;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200605
Neels Hofmeyreee24eb2018-11-06 21:39:15 +0100606 /* If a release event is being handled, ignore other ricocheting release events until that
607 * release handling has concluded. */
608 bool in_release_handler;
Harald Welte963763d2019-02-03 12:11:12 +0100609
610 /* is this release at the end of a CSFB call? */
611 bool is_csfb;
Neels Hofmeyreee24eb2018-11-06 21:39:15 +0100612 } release;
Neels Hofmeyrd5df9a12018-07-20 05:35:47 +0200613
Neels Hofmeyr10485162018-02-13 23:22:03 +0100614 /* The logical channel type */
615 enum gsm_chan_t type;
616 /* RSL channel mode */
617 enum rsl_cmod_spd rsl_cmode;
618 /* If TCH, traffic channel mode */
619 enum gsm48_chan_mode tch_mode;
620 enum lchan_csd_mode csd_mode;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100621 /* Power levels for MS and BTS */
622 uint8_t bs_power;
623 uint8_t ms_power;
624 /* Encryption information */
625 struct gsm_encr encr;
626
627 /* AMR bits */
628 uint8_t mr_ms_lv[7];
629 uint8_t mr_bts_lv[7];
Neels Hofmeyr4daa2102019-01-30 16:46:58 +0100630 /* AMR bits were based on these rate bits: */
631 uint16_t s15_s0;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100632
633 /* Established data link layer services */
634 uint8_t sapis[8];
635
636 struct {
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200637 uint32_t bound_ip; /*< where the BTS receives RTP */
Neels Hofmeyr10485162018-02-13 23:22:03 +0100638 uint16_t bound_port;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200639 uint32_t connect_ip; /*< where the BTS sends RTP to (MGW) */
Neels Hofmeyr10485162018-02-13 23:22:03 +0100640 uint16_t connect_port;
641 uint16_t conn_id;
642 uint8_t rtp_payload;
643 uint8_t rtp_payload2;
644 uint8_t speech_mode;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100645
646 /* info we need to postpone the AoIP
647 * assignment completed message */
648 struct {
649 uint8_t rr_cause;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100650 bool valid;
651 } ass_compl;
652 } abis_ip;
653
654 uint8_t rqd_ta;
655
Neels Hofmeyr10485162018-02-13 23:22:03 +0100656 /* table of neighbor cell measurements */
657 struct neigh_meas_proc neigh_meas[MAX_NEIGH_MEAS];
658
659 /* cache of last measurement reports on this lchan */
660 struct gsm_meas_rep meas_rep[MAX_MEAS_REP];
661 int meas_rep_idx;
662 int meas_rep_count;
Neels Hofmeyr35ba85c2018-02-12 16:47:40 +0100663 uint8_t meas_rep_last_seen_nr;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100664
665 /* GSM Random Access data */
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200666 /* TODO: don't allocate this, rather keep an "is_present" flag */
Neels Hofmeyr10485162018-02-13 23:22:03 +0100667 struct gsm48_req_ref *rqd_ref;
668
669 struct gsm_subscriber_connection *conn;
Philipp Maierbb66d102019-01-22 11:29:06 +0100670
671 /* Depending on the preferences that where submitted together with
672 * the assignment and the current channel load, the BSC has to select
673 * one of the offered codec/rates. The final selection by the BSC is
674 * stored here and is used when sending the assignment complete or
675 * when performing a handover procedure. */
676 struct channel_mode_and_rate ch_mode_rate;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100677};
678
Neels Hofmeyr10485162018-02-13 23:22:03 +0100679/* One Timeslot in a TRX */
680struct gsm_bts_trx_ts {
681 struct gsm_bts_trx *trx;
682 /* number of this timeslot at the TRX */
683 uint8_t nr;
684
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200685 struct osmo_fsm_inst *fi;
686 char *last_errmsg;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100687
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200688 /* vty phys_chan_config setting, not necessarily in effect in case it was changed in the telnet
689 * vty after OML activation. Gets written on vty 'write file'. */
690 enum gsm_phys_chan_config pchan_from_config;
691 /* When the timeslot OML is established, pchan_from_config is copied here. This is the pchan
692 * currently in effect; for dynamic ts, this is the dyn kind (GSM_PCHAN_TCH_F_TCH_H_PDCH or
693 * GSM_PCHAN_TCH_F_PDCH) and does not show the pchan type currently active. */
694 enum gsm_phys_chan_config pchan_on_init;
695 /* This is the *actual* pchan type currently active. For dynamic timeslots, this reflects either
696 * GSM_PCHAN_NONE or one of the standard GSM_PCHAN_TCH_F, GSM_PCHAN_TCH_H, GSM_PCHAN_PDCH.
697 * Callers can use this transparently without being aware of dyn ts. */
698 enum gsm_phys_chan_config pchan_is;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100699
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200700 /* After a PDCH ACT NACK, we shall not infinitely loop to try and ACT again.
701 * Also marks a timeslot where PDCH was deactivated by VTY. This is cleared whenever a timeslot
702 * enters IN_USE state, i.e. after each TCH use we try to PDCH ACT once again. */
703 bool pdch_act_allowed;
704
Neels Hofmeyrbcdbfb72018-07-26 20:33:15 +0200705 /* Whether TS_EV_OML_READY was received */
706 bool is_oml_ready;
707 /* Whether TS_EV_RSL_READY was received */
708 bool is_rsl_ready;
709
Neels Hofmeyr10485162018-02-13 23:22:03 +0100710 struct gsm_abis_mo mo;
711 struct tlv_parsed nm_attr;
712 uint8_t nm_chan_comb;
713 int tsc; /* -1 == use BTS TSC */
714
715 struct {
716 /* Parameters below are configured by VTY */
717 int enabled;
718 uint8_t maio;
719 uint8_t hsn;
720 struct bitvec arfcns;
721 uint8_t arfcns_data[1024/8];
722 /* This is the pre-computed MA for channel assignments */
723 struct bitvec ma;
724 uint8_t ma_len; /* part of ma_data that is used */
725 uint8_t ma_data[8]; /* 10.5.2.21: max 8 bytes value part */
726 } hopping;
727
728 /* To which E1 subslot are we connected */
729 struct gsm_e1_subslot e1_link;
730
731 union {
732 struct {
733 struct om2k_mo om2k_mo;
734 } rbs2000;
735 };
736
737 struct gsm_lchan lchan[TS_MAX_LCHAN];
738};
739
Neels Hofmeyr10485162018-02-13 23:22:03 +0100740#define GSM_LCHAN_SI(lchan, i) (void *)((lchan)->si.buf[i][0])
741
Neels Hofmeyr10485162018-02-13 23:22:03 +0100742/*
743 * This keeps track of the paging status of one BTS. It
744 * includes a number of pending requests, a back pointer
745 * to the gsm_bts, a timer and some more state.
746 */
747struct gsm_bts_paging_state {
748 /* pending requests */
749 struct llist_head pending_requests;
750 struct gsm_bts *bts;
751
752 struct osmo_timer_list work_timer;
753 struct osmo_timer_list credit_timer;
754
755 /* free chans needed */
756 int free_chans_need;
757
758 /* load */
759 uint16_t available_slots;
760};
761
762struct gsm_envabtse {
763 struct gsm_abis_mo mo;
764};
765
766struct gsm_bts_gprs_nsvc {
767 struct gsm_bts *bts;
768 /* data read via VTY config file, to configure the BTS
769 * via OML from BSC */
770 int id;
771 uint16_t nsvci;
772 uint16_t local_port; /* on the BTS */
Alexander Couzens2f9df962020-09-21 18:35:24 +0200773 struct osmo_sockaddr remote;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100774 struct gsm_abis_mo mo;
775};
776
777enum gprs_rlc_par {
778 RLC_T3142,
779 RLC_T3169,
780 RLC_T3191,
781 RLC_T3193,
782 RLC_T3195,
783 RLC_N3101,
784 RLC_N3103,
785 RLC_N3105,
786 CV_COUNTDOWN,
787 T_DL_TBF_EXT, /* ms */
788 T_UL_TBF_EXT, /* ms */
789 _NUM_RLC_PAR
790};
791
792enum gprs_cs {
793 GPRS_CS1,
794 GPRS_CS2,
795 GPRS_CS3,
796 GPRS_CS4,
797 GPRS_MCS1,
798 GPRS_MCS2,
799 GPRS_MCS3,
800 GPRS_MCS4,
801 GPRS_MCS5,
802 GPRS_MCS6,
803 GPRS_MCS7,
804 GPRS_MCS8,
805 GPRS_MCS9,
806 _NUM_GRPS_CS
807};
808
809struct gprs_rlc_cfg {
810 uint16_t parameter[_NUM_RLC_PAR];
811 struct {
812 uint16_t repeat_time; /* ms */
813 uint8_t repeat_count;
814 } paging;
815 uint32_t cs_mask; /* bitmask of gprs_cs */
816 uint8_t initial_cs;
817 uint8_t initial_mcs;
818};
819
820
821enum neigh_list_manual_mode {
822 NL_MODE_AUTOMATIC = 0,
823 NL_MODE_MANUAL = 1,
824 NL_MODE_MANUAL_SI5SEP = 2, /* SI2 and SI5 have separate neighbor lists */
825};
826
827enum bts_loc_fix {
828 BTS_LOC_FIX_INVALID = 0,
829 BTS_LOC_FIX_2D = 1,
830 BTS_LOC_FIX_3D = 2,
831};
832
833extern const struct value_string bts_loc_fix_names[];
834
835struct bts_location {
836 struct llist_head list;
837 time_t tstamp;
838 enum bts_loc_fix valid;
839 double lat;
840 double lon;
841 double height;
842};
843
844/* Channel load counter */
845struct load_counter {
846 unsigned int total;
847 unsigned int used;
848};
849
Neels Hofmeyr19bed232018-03-22 04:54:57 +0100850/* Useful to track N-N relations between BTS, for example neighbors. */
851struct gsm_bts_ref {
852 struct llist_head entry;
853 struct gsm_bts *bts;
854};
855
Harald Welted41b7c72019-06-13 09:41:58 +0200856/* A single Page of a SMSCB message */
857struct bts_smscb_page {
858 /* SMSCB message we're part of */
859 struct bts_smscb_message *msg;
860 /* Page Number within message (1 to 15) */
861 uint8_t nr;
862 /* number of valid blocks in data (up to 4) */
863 uint8_t num_blocks;
864 /* up to four blocks of 22 bytes each */
865 uint8_t data[88];
866};
867
868/* A SMSCB message (received from CBSP) */
869struct bts_smscb_message {
870 /* entry in bts_smscb_chan_state.messages */
871 struct llist_head list;
872 struct {
873 /* input data from CBSP (CBC) side */
874 uint16_t msg_id;
875 uint16_t serial_nr;
876 enum cbsp_category category;
877 uint16_t rep_period;
878 uint16_t num_bcast_req;
879 uint8_t dcs;
880 } input;
881 /* how often have all pages of this message been broadcast? */
882 uint32_t bcast_count;
883 /* actual page data of this message */
884 uint8_t num_pages; /* up to 15 */
885 struct bts_smscb_page page[15];
886};
887
888/* per-channel (basic/extended) CBCH state for a single BTS */
889struct bts_smscb_chan_state {
890 /* back-pointer to BTS */
891 struct gsm_bts *bts;
892 /* list of bts_smscb_message */
893 struct llist_head messages;
894 /* scheduling array; pointer of SMSCB pages */
895 struct bts_smscb_page **sched_arr;
896 size_t sched_arr_size;
897 /* index of the next to be transmitted page into the scheduler array */
898 size_t next_idx;
899 /* number of messages we have to pause due to overflow */
900 uint8_t overflow;
901};
902
Oliver Smithba0a1222020-03-18 12:39:30 +0100903struct bts_oml_fail_rep {
904 struct llist_head list;
905 time_t time;
906 struct msgb *mb;
907};
908
Oliver Smith8d8d7102018-10-23 15:35:43 +0200909/* One rejected BTS */
910struct gsm_bts_rejected {
911 /* list header in net->bts_rejected */
912 struct llist_head list;
913
914 uint16_t site_id;
915 uint16_t bts_id;
916 char ip[INET6_ADDRSTRLEN];
917 time_t time;
918};
Neels Hofmeyr10485162018-02-13 23:22:03 +0100919
Neels Hofmeyr638eb992020-09-16 00:56:19 +0200920extern struct osmo_tdef_group bsc_tdef_group[];
921
Neels Hofmeyr958f2592018-05-27 01:26:31 +0200922struct gsm_network *gsm_network_init(void *ctx);
923
Neels Hofmeyr6d568ed2018-07-09 16:49:18 +0200924struct gsm_bts *gsm_bts_num(const struct gsm_network *net, int num);
Neels Hofmeyr19bed232018-03-22 04:54:57 +0100925struct gsm_bts *gsm_bts_by_cell_id(const struct gsm_network *net,
926 const struct gsm0808_cell_id *cell_id,
927 int match_idx);
Neels Hofmeyr10485162018-02-13 23:22:03 +0100928
Neels Hofmeyr10485162018-02-13 23:22:03 +0100929extern const struct value_string gsm_chreq_descs[];
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200930extern const struct value_string gsm_pchant_names[];
931extern const struct value_string gsm_pchant_descs[];
932extern const struct value_string gsm_pchan_ids[];
Neels Hofmeyr10485162018-02-13 23:22:03 +0100933const char *gsm_pchan_name(enum gsm_phys_chan_config c);
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200934static inline const char *gsm_pchan_id(enum gsm_phys_chan_config c)
935{ return get_value_string(gsm_pchan_ids, c); }
Neels Hofmeyr10485162018-02-13 23:22:03 +0100936enum gsm_phys_chan_config gsm_pchan_parse(const char *name);
937const char *gsm_lchant_name(enum gsm_chan_t c);
938const char *gsm_chreq_name(enum gsm_chreq_reason_t c);
Neels Hofmeyr10485162018-02-13 23:22:03 +0100939char *gsm_ts_name(const struct gsm_bts_trx_ts *ts);
940char *gsm_ts_and_pchan_name(const struct gsm_bts_trx_ts *ts);
941char *gsm_lchan_name_compute(const struct gsm_lchan *lchan);
Neels Hofmeyr10485162018-02-13 23:22:03 +0100942
943static inline char *gsm_lchan_name(const struct gsm_lchan *lchan)
944{
945 return lchan->name;
946}
947
Neels Hofmeyr10485162018-02-13 23:22:03 +0100948void gsm_abis_mo_reset(struct gsm_abis_mo *mo);
Pau Espin Pedrol388ed582020-07-15 20:53:16 +0200949void gsm_mo_init(struct gsm_abis_mo *mo, struct gsm_bts *bts,
950 uint8_t obj_class, uint8_t p1, uint8_t p2, uint8_t p3);
Neels Hofmeyr10485162018-02-13 23:22:03 +0100951
952struct gsm_nm_state *
953gsm_objclass2nmstate(struct gsm_bts *bts, uint8_t obj_class,
954 const struct abis_om_obj_inst *obj_inst);
955void *
956gsm_objclass2obj(struct gsm_bts *bts, uint8_t obj_class,
957 const struct abis_om_obj_inst *obj_inst);
958
Neels Hofmeyr10485162018-02-13 23:22:03 +0100959uint8_t gsm_pchan2chan_nr(enum gsm_phys_chan_config pchan,
960 uint8_t ts_nr, uint8_t lchan_nr);
961uint8_t gsm_lchan2chan_nr(const struct gsm_lchan *lchan);
962uint8_t gsm_lchan_as_pchan2chan_nr(const struct gsm_lchan *lchan,
963 enum gsm_phys_chan_config as_pchan);
964
Harald Welte251bec12018-09-09 17:14:09 +0200965void gsm48_lchan2chan_desc(struct gsm48_chan_desc *cd,
966 const struct gsm_lchan *lchan);
Harald Welte24286f32018-09-09 17:17:44 +0200967void gsm48_lchan2chan_desc_as_configured(struct gsm48_chan_desc *cd, const struct gsm_lchan *lchan);
Harald Welte251bec12018-09-09 17:14:09 +0200968
Pau Espin Pedrol388ed582020-07-15 20:53:16 +0200969uint8_t gsm_ts_tsc(const struct gsm_bts_trx_ts *ts);
Neels Hofmeyr10485162018-02-13 23:22:03 +0100970
Neels Hofmeyr10485162018-02-13 23:22:03 +0100971enum gsm_phys_chan_config ts_pchan(struct gsm_bts_trx_ts *ts);
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200972uint8_t pchan_subslots(enum gsm_phys_chan_config pchan);
Neels Hofmeyr10485162018-02-13 23:22:03 +0100973bool ts_is_tch(struct gsm_bts_trx_ts *ts);
974
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100975
Pau Espin Pedrol388ed582020-07-15 20:53:16 +0200976struct gsm_bts *conn_get_bts(struct gsm_subscriber_connection *conn);
Harald Welteb7948872017-12-18 18:48:21 +0100977
Pau Espin Pedrol7950e5d2019-10-31 15:59:49 +0100978void conn_update_ms_power_class(struct gsm_subscriber_connection *conn, uint8_t power_class);
979void lchan_update_ms_power_ctrl_level(struct gsm_lchan *lchan, int ms_power_dbm);
980
Stefan Sperling81dc9e72018-02-05 17:34:36 +0100981enum {
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200982 BSC_CTR_ASSIGNMENT_ATTEMPTED,
983 BSC_CTR_ASSIGNMENT_COMPLETED,
984 BSC_CTR_ASSIGNMENT_STOPPED,
985 BSC_CTR_ASSIGNMENT_NO_CHANNEL,
986 BSC_CTR_ASSIGNMENT_TIMEOUT,
987 BSC_CTR_ASSIGNMENT_FAILED,
988 BSC_CTR_ASSIGNMENT_ERROR,
Alexander Couzensb847a212016-08-02 11:34:11 +0200989 BSC_CTR_HANDOVER_ATTEMPTED,
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200990 BSC_CTR_HANDOVER_COMPLETED,
991 BSC_CTR_HANDOVER_STOPPED,
Alexander Couzensb847a212016-08-02 11:34:11 +0200992 BSC_CTR_HANDOVER_NO_CHANNEL,
993 BSC_CTR_HANDOVER_TIMEOUT,
Alexander Couzensb847a212016-08-02 11:34:11 +0200994 BSC_CTR_HANDOVER_FAILED,
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200995 BSC_CTR_HANDOVER_ERROR,
Daniel Willmannbf2a4b62020-08-20 15:25:37 +0200996 BSC_CTR_INTRA_CELL_HO_ATTEMPTED,
997 BSC_CTR_INTRA_CELL_HO_COMPLETED,
998 BSC_CTR_INTRA_CELL_HO_STOPPED,
999 BSC_CTR_INTRA_CELL_HO_NO_CHANNEL,
1000 BSC_CTR_INTRA_CELL_HO_TIMEOUT,
1001 BSC_CTR_INTRA_CELL_HO_FAILED,
1002 BSC_CTR_INTRA_CELL_HO_ERROR,
1003 BSC_CTR_INTRA_BSC_HO_ATTEMPTED,
1004 BSC_CTR_INTRA_BSC_HO_COMPLETED,
1005 BSC_CTR_INTRA_BSC_HO_STOPPED,
1006 BSC_CTR_INTRA_BSC_HO_NO_CHANNEL,
1007 BSC_CTR_INTRA_BSC_HO_TIMEOUT,
1008 BSC_CTR_INTRA_BSC_HO_FAILED,
1009 BSC_CTR_INTRA_BSC_HO_ERROR,
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001010 BSC_CTR_INTER_BSC_HO_OUT_ATTEMPTED,
1011 BSC_CTR_INTER_BSC_HO_OUT_COMPLETED,
1012 BSC_CTR_INTER_BSC_HO_OUT_STOPPED,
1013 BSC_CTR_INTER_BSC_HO_OUT_TIMEOUT,
Neels Hofmeyrdbe59f62020-08-29 03:23:31 +00001014 BSC_CTR_INTER_BSC_HO_OUT_FAILED,
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001015 BSC_CTR_INTER_BSC_HO_OUT_ERROR,
1016 BSC_CTR_INTER_BSC_HO_IN_ATTEMPTED,
1017 BSC_CTR_INTER_BSC_HO_IN_COMPLETED,
1018 BSC_CTR_INTER_BSC_HO_IN_STOPPED,
1019 BSC_CTR_INTER_BSC_HO_IN_NO_CHANNEL,
1020 BSC_CTR_INTER_BSC_HO_IN_FAILED,
1021 BSC_CTR_INTER_BSC_HO_IN_TIMEOUT,
1022 BSC_CTR_INTER_BSC_HO_IN_ERROR,
Alexander Couzensb847a212016-08-02 11:34:11 +02001023 BSC_CTR_PAGING_ATTEMPTED,
1024 BSC_CTR_PAGING_DETACHED,
Harald Weltecf9d4312017-12-13 23:17:16 +01001025 BSC_CTR_PAGING_RESPONDED,
Alexander Chemeris43def742020-05-16 18:49:59 +03001026 BSC_CTR_PAGING_NO_ACTIVE_PAGING,
Stefan Sperling7926d982018-05-17 14:52:02 +02001027 BSC_CTR_UNKNOWN_UNIT_ID,
Neels Hofmeyr1c963eb2020-06-16 12:08:39 +02001028 BSC_CTR_MSCPOOL_SUBSCR_NO_MSC,
1029 BSC_CTR_MSCPOOL_EMERG_FORWARDED,
1030 BSC_CTR_MSCPOOL_EMERG_LOST,
Alexander Couzensb847a212016-08-02 11:34:11 +02001031};
1032
1033static const struct rate_ctr_desc bsc_ctr_description[] = {
Daniel Willmann45062b42020-08-20 18:37:51 +02001034 [BSC_CTR_ASSIGNMENT_ATTEMPTED] = {"assignment:attempted", "Assignment attempts"},
1035 [BSC_CTR_ASSIGNMENT_COMPLETED] = {"assignment:completed", "Assignment completed"},
1036 [BSC_CTR_ASSIGNMENT_STOPPED] = {"assignment:stopped", "Connection ended during Assignment"},
1037 [BSC_CTR_ASSIGNMENT_NO_CHANNEL] = {"assignment:no_channel", "Failure to allocate lchan for Assignment"},
1038 [BSC_CTR_ASSIGNMENT_TIMEOUT] = {"assignment:timeout", "Assignment timed out"},
1039 [BSC_CTR_ASSIGNMENT_FAILED] = {"assignment:failed", "Received Assignment Failure message"},
1040 [BSC_CTR_ASSIGNMENT_ERROR] = {"assignment:error", "Assignment failed for other reason"},
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001041
Daniel Willmann45062b42020-08-20 18:37:51 +02001042 [BSC_CTR_HANDOVER_ATTEMPTED] = {"handover:attempted", "Intra-BSC handover attempts"},
1043 [BSC_CTR_HANDOVER_COMPLETED] = {"handover:completed", "Intra-BSC handover completed"},
1044 [BSC_CTR_HANDOVER_STOPPED] = {"handover:stopped", "Connection ended during HO"},
1045 [BSC_CTR_HANDOVER_NO_CHANNEL] = {"handover:no_channel", "Failure to allocate lchan for HO"},
1046 [BSC_CTR_HANDOVER_TIMEOUT] = {"handover:timeout", "Handover timed out"},
1047 [BSC_CTR_HANDOVER_FAILED] = {"handover:failed", "Received Handover Fail messages"},
1048 [BSC_CTR_HANDOVER_ERROR] = {"handover:error", "Re-assignment failed for other reason"},
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001049
Daniel Willmannbf2a4b62020-08-20 15:25:37 +02001050 [BSC_CTR_INTRA_CELL_HO_ATTEMPTED] = {"intra_cell_ho:attempted", "Intra-Cell handover attempts"},
1051 [BSC_CTR_INTRA_CELL_HO_COMPLETED] = {"intra_cell_ho:completed", "Intra-Cell handover completed"},
1052 [BSC_CTR_INTRA_CELL_HO_STOPPED] = {"intra_cell_ho:stopped", "Connection ended during HO"},
1053 [BSC_CTR_INTRA_CELL_HO_NO_CHANNEL] = {"intra_cell_ho:no_channel", "Failure to allocate lchan for HO"},
1054 [BSC_CTR_INTRA_CELL_HO_TIMEOUT] = {"intra_cell_ho:timeout", "Handover timed out"},
1055 [BSC_CTR_INTRA_CELL_HO_FAILED] = {"intra_cell_ho:failed", "Received Handover Fail messages"},
1056 [BSC_CTR_INTRA_CELL_HO_ERROR] = {"intra_cell_ho:error", "Re-assignment failed for other reason"},
1057
1058 [BSC_CTR_INTRA_BSC_HO_ATTEMPTED] = {"intra_bsc_ho:attempted", "Intra-BSC handover attempts"},
1059 [BSC_CTR_INTRA_BSC_HO_COMPLETED] = {"intra_bsc_ho:completed", "Intra-BSC handover completed"},
1060 [BSC_CTR_INTRA_BSC_HO_STOPPED] = {"intra_bsc_ho:stopped", "Connection ended during HO"},
1061 [BSC_CTR_INTRA_BSC_HO_NO_CHANNEL] = {"intra_bsc_ho:no_channel", "Failure to allocate lchan for HO"},
1062 [BSC_CTR_INTRA_BSC_HO_TIMEOUT] = {"intra_bsc_ho:timeout", "Handover timed out"},
1063 [BSC_CTR_INTRA_BSC_HO_FAILED] = {"intra_bsc_ho:failed", "Received Handover Fail messages"},
1064 [BSC_CTR_INTRA_BSC_HO_ERROR] = {"intra_bsc_ho:error", "Re-assignment failed for other reason"},
1065
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001066 [BSC_CTR_INTER_BSC_HO_OUT_ATTEMPTED] = {"interbsc_ho_out:attempted",
Daniel Willmann45062b42020-08-20 18:37:51 +02001067 "Attempts to handover to remote BSS"},
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001068 [BSC_CTR_INTER_BSC_HO_OUT_COMPLETED] = {"interbsc_ho_out:completed",
Daniel Willmann45062b42020-08-20 18:37:51 +02001069 "Handover to remote BSS completed"},
1070 [BSC_CTR_INTER_BSC_HO_OUT_STOPPED] = {"interbsc_ho_out:stopped", "Connection ended during HO"},
1071 [BSC_CTR_INTER_BSC_HO_OUT_TIMEOUT] = {"interbsc_ho_out:timeout", "Handover timed out"},
Neels Hofmeyrdbe59f62020-08-29 03:23:31 +00001072 [BSC_CTR_INTER_BSC_HO_OUT_FAILED] = {"interbsc_ho_out:failed", "Received Handover Fail message"},
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001073 [BSC_CTR_INTER_BSC_HO_OUT_ERROR] = {"interbsc_ho_out:error",
Daniel Willmann45062b42020-08-20 18:37:51 +02001074 "Handover to remote BSS failed for other reason"},
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001075
1076 [BSC_CTR_INTER_BSC_HO_IN_ATTEMPTED] = {"interbsc_ho_in:attempted",
Daniel Willmann45062b42020-08-20 18:37:51 +02001077 "Attempts to handover from remote BSS"},
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001078 [BSC_CTR_INTER_BSC_HO_IN_COMPLETED] = {"interbsc_ho_in:completed",
Daniel Willmann45062b42020-08-20 18:37:51 +02001079 "Handover from remote BSS completed"},
1080 [BSC_CTR_INTER_BSC_HO_IN_STOPPED] = {"interbsc_ho_in:stopped", "Connection ended during HO"},
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001081 [BSC_CTR_INTER_BSC_HO_IN_NO_CHANNEL] = {"interbsc_ho_in:no_channel",
Daniel Willmann45062b42020-08-20 18:37:51 +02001082 "Failure to allocate lchan for HO"},
1083 [BSC_CTR_INTER_BSC_HO_IN_TIMEOUT] = {"interbsc_ho_in:timeout", "Handover from remote BSS timed out"},
1084 [BSC_CTR_INTER_BSC_HO_IN_FAILED] = {"interbsc_ho_in:failed", "Received Handover Fail message"},
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001085 [BSC_CTR_INTER_BSC_HO_IN_ERROR] = {"interbsc_ho_in:error",
Daniel Willmann45062b42020-08-20 18:37:51 +02001086 "Handover from remote BSS failed for other reason"},
Harald Weltecf9d4312017-12-13 23:17:16 +01001087
Daniel Willmann45062b42020-08-20 18:37:51 +02001088 [BSC_CTR_PAGING_ATTEMPTED] = {"paging:attempted", "Paging attempts for a subscriber"},
1089 [BSC_CTR_PAGING_DETACHED] = {"paging:detached", "Paging request send failures because no responsible BTS was found"},
1090 [BSC_CTR_PAGING_RESPONDED] = {"paging:responded", "Paging attempts with successful response"},
1091 [BSC_CTR_PAGING_NO_ACTIVE_PAGING] = {"paging:no_active_paging", "Paging response without an active paging request (arrived after paging expiration?)"},
Stefan Sperling7926d982018-05-17 14:52:02 +02001092
Daniel Willmann45062b42020-08-20 18:37:51 +02001093 [BSC_CTR_UNKNOWN_UNIT_ID] = {"abis:unknown_unit_id", "Connection attempts from unknown IPA CCM Unit ID"},
Neels Hofmeyr1c963eb2020-06-16 12:08:39 +02001094
1095 [BSC_CTR_MSCPOOL_SUBSCR_NO_MSC] = {"mscpool:subscr:no_msc",
Daniel Willmann45062b42020-08-20 18:37:51 +02001096 "Complete Layer 3 requests lost because no connected MSC is found available"},
Neels Hofmeyr1c963eb2020-06-16 12:08:39 +02001097 [BSC_CTR_MSCPOOL_EMERG_FORWARDED] = {"mscpool:emerg:forwarded",
Daniel Willmann45062b42020-08-20 18:37:51 +02001098 "Emergency call requests forwarded to an MSC (see also per-MSC counters"},
Neels Hofmeyr1c963eb2020-06-16 12:08:39 +02001099 [BSC_CTR_MSCPOOL_EMERG_LOST] = {"mscpool:emerg:lost",
Daniel Willmann45062b42020-08-20 18:37:51 +02001100 "Emergency call requests lost because no MSC was found available"},
Alexander Couzensb847a212016-08-02 11:34:11 +02001101};
1102
Alexander Couzensb847a212016-08-02 11:34:11 +02001103
1104
1105static const struct rate_ctr_group_desc bsc_ctrg_desc = {
1106 "bsc",
1107 "base station controller",
1108 OSMO_STATS_CLASS_GLOBAL,
1109 ARRAY_SIZE(bsc_ctr_description),
1110 bsc_ctr_description,
Alexander Couzens20423ea2016-07-12 15:42:02 +02001111};
1112
Alexander Chemerisdb542832020-05-08 01:49:12 +03001113/* Constants for the BSC stats */
1114enum {
1115 BSC_STAT_NUM_BTS_TOTAL,
1116};
1117
Daniel Willmannaa420ce2020-08-20 15:37:35 +02001118/* BTS counter index if a BTS could not be found
1119 * Currently we are limited to bts 0 - 255 in the VTY, but that might change in
1120 * the future so use 2**16 */
1121#define BTS_STAT_IDX_UNKNOWN (UINT16_MAX + 1)
1122
Neels Hofmeyr73983952016-05-10 13:29:33 +02001123struct gsm_tz {
1124 int override; /* if 0, use system's time zone instead. */
1125 int hr; /* hour */
1126 int mn; /* minute */
1127 int dst; /* daylight savings */
1128};
1129
Harald Welte52b1f982008-12-23 20:25:15 +00001130struct gsm_network {
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +02001131 /* TODO MSCSPLIT the gsm_network struct is basically a kitchen sink for
1132 * global settings and variables, "madly" mixing BSC and MSC stuff. Split
1133 * this in e.g. struct osmo_bsc and struct osmo_msc, with the things
1134 * these have in common, like country and network code, put in yet
1135 * separate structs and placed as members in osmo_bsc and osmo_msc. */
1136
Neels Hofmeyrf93970b2018-03-05 02:09:40 +01001137 struct osmo_plmn_id plmn;
1138
Harald Welte51e4bf32017-12-23 17:30:18 +01001139 /* bit-mask of permitted encryption algorithms. LSB=A5/0, MSB=A5/7 */
1140 uint8_t a5_encryption_mask;
Holger Hans Peter Freytherf7d752f2009-11-16 17:12:38 +01001141 int neci;
Neels Hofmeyr909e9722017-12-07 03:54:01 +01001142
Neels Hofmeyre25018b2017-11-27 21:29:33 +01001143 struct handover_cfg *ho;
Neels Hofmeyr909e9722017-12-07 03:54:01 +01001144 struct {
1145 unsigned int congestion_check_interval_s;
1146 struct osmo_timer_list congestion_check_timer;
1147 } hodec2;
Harald Welte52b1f982008-12-23 20:25:15 +00001148
Alexander Chemerisdb542832020-05-08 01:49:12 +03001149 /* structures for keeping rate counters and gauge stats */
Alexander Couzensb847a212016-08-02 11:34:11 +02001150 struct rate_ctr_group *bsc_ctrs;
Alexander Chemerisdb542832020-05-08 01:49:12 +03001151 struct osmo_stat_item_group *bsc_statg;
Harald Welte24ff6ee2009-12-22 00:41:05 +01001152
Harald Welte52b1f982008-12-23 20:25:15 +00001153 unsigned int num_bts;
Harald Weltee441d9c2009-06-21 16:17:15 +02001154 struct llist_head bts_list;
Oliver Smith8d8d7102018-10-23 15:35:43 +02001155 struct llist_head bts_rejected;
Holger Hans Peter Freytherc4d88ad2009-11-21 21:18:38 +01001156
Daniel Willmannaa420ce2020-08-20 15:37:35 +02001157 /* BTS-based counters when we can't find the actual BTS
1158 * e.g. when conn->lchan is NULL */
1159 struct rate_ctr_group *bts_unknown_ctrs;
1160 struct osmo_stat_item_group *bts_unknown_statg;
1161
Neels Hofmeyr08822a32019-07-11 03:43:34 +02001162 /* see gsm_network_T_defs */
Neels Hofmeyra6078fe2019-01-28 03:52:14 +01001163 struct osmo_tdef *T_defs;
Harald Welteeab84a12009-12-13 10:53:12 +01001164
Alexander Couzens547c2072017-11-21 12:03:04 +01001165 enum gsm_chan_t ctype_by_chreq[_NUM_CHREQ_T];
Holger Hans Peter Freyther78891072010-09-06 09:36:02 +08001166
Holger Hans Peter Freyther76fc4a32010-09-06 09:41:50 +08001167 /* Use a TCH for handling requests of type paging any */
1168 int pag_any_tch;
1169
Neels Hofmeyr06a14d22020-05-26 12:41:18 +02001170 /* msc configuration */
1171 struct llist_head mscs;
Neels Hofmeyreec776e2020-05-25 00:02:56 +02001172 uint8_t mscs_round_robin_next_nr;
1173 /* Emergency calls potentially select a different set of MSCs, so to not mess up the normal round-robin
1174 * behavior, emergency calls need a separate round-robin counter. */
1175 uint8_t mscs_round_robin_next_emerg_nr;
Neels Hofmeyr06a14d22020-05-26 12:41:18 +02001176
1177 /* rf ctl related bits */
1178 int mid_call_timeout;
1179 char *rf_ctrl_name;
1180 struct osmo_bsc_rf *rf_ctrl;
1181 int auto_off_timeout;
1182
1183 struct bsc_cbc_link *cbc;
Holger Hans Peter Freytherdaee5ca2010-12-22 12:34:39 +01001184
Daniel Willmann6fc4a982011-07-22 17:55:42 +02001185 /* control interface */
1186 struct ctrl_handle *ctrl;
Neels Hofmeyr5f0c71b2016-07-23 20:15:28 +02001187
1188 /* Allow or disallow TCH/F on dynamic TCH/F_TCH/H_PDCH; OS#1778 */
1189 bool dyn_ts_allow_tch_f;
Neels Hofmeyrd90fa422016-05-09 21:03:12 +02001190
1191 /* all active subscriber connections. */
1192 struct llist_head subscr_conns;
Neels Hofmeyr73983952016-05-10 13:29:33 +02001193
1194 /* if override is nonzero, this timezone data is used for all MM
1195 * contexts. */
1196 /* TODO: in OsmoNITB, tz-override used to be BTS-specific. To enable
1197 * BTS|RNC specific timezone overrides for multi-tz networks in
Neels Hofmeyrfe291de2017-02-23 21:06:12 +01001198 * OsmoMSC, this should be tied to the location area code (LAC). */
Neels Hofmeyr73983952016-05-10 13:29:33 +02001199 struct gsm_tz tz;
Neels Hofmeyr6d804b12017-02-18 22:20:46 +01001200
1201 /* List of all struct bsc_subscr used in libbsc. This llist_head is
1202 * allocated so that the llist_head pointer itself can serve as a
1203 * talloc context (useful to not have to pass the entire gsm_network
1204 * struct to the bsc_subscr_* API, and for bsc_susbscr unit tests to
1205 * not require gsm_data.h). In an MSC-without-BSC environment, this
1206 * pointer is NULL to indicate absence of a bsc_subscribers list. */
1207 struct llist_head *bsc_subscribers;
Harald Weltea43e0b42016-06-19 18:06:02 +02001208
Stefan Sperling6cee8932018-01-30 18:14:22 +01001209 /* Timer for periodic channel load measurements to maintain each BTS's T3122. */
1210 struct osmo_timer_list t3122_chan_load_timer;
1211
Neels Hofmeyrc29505e2016-05-20 21:59:55 +02001212 struct {
Philipp Maier39c609b2017-09-27 15:51:34 +02001213 struct mgcp_client_conf *conf;
1214 struct mgcp_client *client;
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +02001215 struct osmo_tdef *tdefs;
Philipp Maier39c609b2017-09-27 15:51:34 +02001216 } mgw;
Neels Hofmeyr19bed232018-03-22 04:54:57 +01001217
1218 /* Remote BSS Cell Identifier Lists */
1219 struct neighbor_ident_list *neighbor_bss_cells;
Oliver Smitha595db12020-03-17 12:21:00 +01001220
1221 /* Don't refuse to start with mutually exclusive codec settings */
1222 bool allow_unusable_timeslots;
Neels Hofmeyr4099f1d2020-05-26 03:58:14 +02001223
1224 uint8_t nri_bitlen;
1225 struct osmo_nri_ranges *null_nri_ranges;
Neels Hofmeyr4ae338d2020-09-17 17:54:39 +02001226
1227 struct smlc_config *smlc;
Harald Welte7e310b12009-03-30 20:56:32 +00001228};
1229
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001230struct gsm_audio_support {
1231 uint8_t hr : 1,
1232 ver : 7;
1233};
1234
Neels Hofmeyrc13e6872016-05-11 13:53:47 +02001235extern void talloc_ctx_init(void *ctx_root);
1236
Harald Welte1d014a52009-08-08 15:38:29 +02001237enum gsm_bts_type parse_btstype(const char *arg);
Holger Hans Peter Freyther2dceae62009-06-12 17:39:38 +02001238const char *btstype2str(enum gsm_bts_type type);
Harald Weltebe991492009-05-23 13:56:40 +00001239struct gsm_bts *gsm_bts_by_lac(struct gsm_network *net, unsigned int lac,
1240 struct gsm_bts *start_bts);
Harald Welte32201c12009-03-10 12:15:10 +00001241
Andreas Eversberg8226fa72009-06-29 15:19:38 +02001242extern void *tall_bsc_ctx;
Harald Welte2cf161b2009-06-20 22:36:41 +02001243
Harald Welte1876c312018-05-27 11:53:43 +02001244extern struct gsm_network *bsc_gsmnet;
1245
Holger Hans Peter Freyther4e13a8f2015-01-31 22:16:00 +01001246enum bts_gprs_mode bts_gprs_mode_parse(const char *arg, int *valid);
Harald Welte4511d892010-04-18 15:51:20 +02001247const char *bts_gprs_mode_name(enum bts_gprs_mode mode);
1248
Neels Hofmeyr4d358c02018-02-22 03:19:05 +01001249void gsm48_ra_id_by_bts(struct gsm48_ra_id *buf, struct gsm_bts *bts);
Harald Welte97a282b2010-03-14 15:37:43 +08001250void gprs_ra_id_by_bts(struct gprs_ra_id *raid, struct gsm_bts *bts);
Harald Welted12b0fd2009-12-15 21:36:05 +01001251
Harald Welte3561bd42018-01-28 03:04:16 +01001252struct gsm_subscriber_connection *bsc_subscr_con_allocate(struct gsm_network *network);
Neels Hofmeyr42eb0142016-05-20 17:15:44 +02001253
Neels Hofmeyr958f2592018-05-27 01:26:31 +02001254struct gsm_bts *gsm_bts_alloc_register(struct gsm_network *net, enum gsm_bts_type type, uint8_t bsic);
1255struct gsm_bts *bsc_bts_alloc_register(struct gsm_network *net, enum gsm_bts_type type, uint8_t bsic);
Harald Welte142d12d2014-12-29 17:47:08 +01001256
Harald Welte3300c012011-06-05 13:31:33 +02001257void set_ts_e1link(struct gsm_bts_trx_ts *ts, uint8_t e1_nr,
1258 uint8_t e1_ts, uint8_t e1_ts_ss);
1259
Pablo Neira Ayusoed5cacb2011-08-17 22:44:07 +02001260/* generic E1 line operations for all ISDN-based BTS. */
1261extern struct e1inp_line_ops bts_isdn_e1inp_line_ops;
1262
Holger Hans Peter Freytherf8c42192013-01-09 17:03:27 +01001263/* control interface handling */
1264int bsc_base_ctrl_cmds_install(void);
1265
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001266bool ts_is_usable(const struct gsm_bts_trx_ts *ts);
Neels Hofmeyr958f2592018-05-27 01:26:31 +02001267
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001268int gsm_lchan_type_by_pchan(enum gsm_phys_chan_config pchan);
1269enum gsm_phys_chan_config gsm_pchan_by_lchan_type(enum gsm_chan_t type);
1270
Neels Hofmeyrb523f542020-07-09 15:54:40 +02001271enum gsm48_rr_cause bsc_gsm48_rr_cause_from_gsm0808_cause(enum gsm0808_cause c);
Neels Hofmeyr3405c772020-07-11 01:44:08 +02001272enum gsm48_rr_cause bsc_gsm48_rr_cause_from_rsl_cause(uint8_t c);
Neels Hofmeyrb523f542020-07-09 15:54:40 +02001273
Neels Hofmeyra33ef3a2020-10-01 04:23:32 +02001274int bsc_sccp_inst_next_conn_id(struct osmo_sccp_instance *sccp);
1275
Harald Welte6be350c2011-05-25 13:10:08 +02001276#endif /* _GSM_DATA_H */