blob: e6a7708b0db2dcbaf566f63c714021d91de0bc96 [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 <regex.h>
6#include <sys/types.h>
Maxe6052c42016-06-30 10:25:49 +02007#include <stdbool.h>
Neels Hofmeyr10485162018-02-13 23:22:03 +01008#include <stdint.h>
Harald Weltef142c972011-05-24 13:25:38 +02009
10#include <osmocom/core/timer.h>
Alexander Couzens20423ea2016-07-12 15:42:02 +020011#include <osmocom/core/rate_ctr.h>
Harald Welte6be350c2011-05-25 13:10:08 +020012#include <osmocom/core/select.h>
Alexander Couzens20423ea2016-07-12 15:42:02 +020013#include <osmocom/core/stats.h>
Stefan Sperling81dc9e72018-02-05 17:34:36 +010014#include <osmocom/core/stat_item.h>
Philipp Maier8c498fc2018-02-21 13:24:36 +010015#include <osmocom/gsm/bts_features.h>
Neels Hofmeyra60f3442018-02-12 16:44:32 +010016#include <osmocom/gsm/protocol/gsm_08_08.h>
Harald Welted41b7c72019-06-13 09:41:58 +020017#include <osmocom/gsm/protocol/gsm_48_049.h>
Neels Hofmeyr31f525e2018-05-14 18:14:15 +020018#include <osmocom/gsm/gsm0808.h>
Neels Hofmeyrf93970b2018-03-05 02:09:40 +010019#include <osmocom/gsm/gsm48.h>
Harald Welte3561bd42018-01-28 03:04:16 +010020#include <osmocom/core/fsm.h>
Neels Hofmeyra6078fe2019-01-28 03:52:14 +010021#include <osmocom/core/tdef.h>
Alexander Couzens20423ea2016-07-12 15:42:02 +020022
Harald Welte121e9a42016-04-20 13:13:19 +020023#include <osmocom/crypt/auth.h>
Harald Weltef142c972011-05-24 13:25:38 +020024
Neels Hofmeyrc0164792017-09-04 15:15:32 +020025#include <osmocom/bsc/rest_octets.h>
Harald Welteb96be392011-05-25 12:33:33 +020026
Neels Hofmeyr10485162018-02-13 23:22:03 +010027#include <osmocom/core/bitvec.h>
28#include <osmocom/gsm/gsm_utils.h>
29#include <osmocom/gsm/rxlev_stat.h>
30#include <osmocom/gsm/protocol/gsm_08_58.h>
31#include <osmocom/gsm/protocol/gsm_12_21.h>
32#include <osmocom/abis/e1_input.h>
33#include <osmocom/bsc/meas_rep.h>
Stefan Sperling6442e432018-02-06 14:44:54 +010034#include <osmocom/bsc/acc_ramp.h>
Neels Hofmeyr31f525e2018-05-14 18:14:15 +020035#include <osmocom/bsc/neighbor_ident.h>
Pau Espin Pedrol83c0f762019-04-16 20:05:32 +020036#include <osmocom/bsc/osmux.h>
Neels Hofmeyr10485162018-02-13 23:22:03 +010037
Neels Hofmeyr596c4022018-06-16 19:29:50 +020038#define GSM_T3122_DEFAULT 10
39
Harald Welte74b8cdb2018-01-15 19:26:06 +010040struct mgcp_client_conf;
41struct mgcp_client;
Neels Hofmeyr19bed232018-03-22 04:54:57 +010042struct gsm0808_cell_id;
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +020043struct osmo_mgcpc_ep;
Philipp Maier39f62bb2017-04-09 12:32:51 +020044
Holger Hans Peter Freytherd7b22c62013-04-29 09:11:02 +020045/** annotations for msgb ownership */
46#define __uses
47
Holger Hans Peter Freyther6f615552010-11-15 20:50:42 +010048#define OBSC_NM_W_ACK_CB(__msgb) (__msgb)->cb[3]
49
Neels Hofmeyr6d804b12017-02-18 22:20:46 +010050struct bsc_subscr;
Neels Hofmeyr7b656882017-07-09 22:09:18 +020051struct gprs_ra_id;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +020052struct handover;
Holger Hans Peter Freyther694c82d2011-10-26 18:37:09 +020053
Holger Hans Peter Freyther9c595b72010-06-15 11:20:52 +080054#define OBSC_LINKID_CB(__msgb) (__msgb)->cb[3]
55
Neels Hofmeyr0e5d8072017-01-10 00:49:56 +010056#define tmsi_from_string(str) strtoul(str, NULL, 10)
57
Max70fdd242017-06-15 15:10:53 +020058/* 3-bit long values */
59#define EARFCN_PRIO_INVALID 8
60#define EARFCN_MEAS_BW_INVALID 8
61/* 5-bit long values */
62#define EARFCN_QRXLV_INVALID 32
63#define EARFCN_THRESH_LOW_INVALID 32
64
Harald Welte8e1e3ee2009-02-01 13:32:45 +000065struct msgb;
66typedef int gsm_cbfn(unsigned int hooknum,
67 unsigned int event,
68 struct msgb *msg,
69 void *data, void *param);
70
Harald Weltef7c28b02009-12-21 13:30:17 +010071/* Maximum number of neighbor cells whose average we track */
72#define MAX_NEIGH_MEAS 10
73/* Maximum size of the averaging window for neighbor cells */
74#define MAX_WIN_NEIGH_AVG 10
Andreas Eversberg98692032013-06-23 10:44:34 +020075/* Maximum number of report history we store */
76#define MAX_MEAS_REP 10
Harald Weltef7c28b02009-12-21 13:30:17 +010077
78/* processed neighbor measurements for one cell */
79struct neigh_meas_proc {
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +020080 uint16_t arfcn;
81 uint8_t bsic;
82 uint8_t rxlev[MAX_WIN_NEIGH_AVG];
Harald Weltef7c28b02009-12-21 13:30:17 +010083 unsigned int rxlev_cnt;
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +020084 uint8_t last_seen_nr;
Harald Weltef7c28b02009-12-21 13:30:17 +010085};
86
Harald Weltea43e0b42016-06-19 18:06:02 +020087struct gsm_classmark {
88 bool classmark1_set;
89 struct gsm48_classmark1 classmark1;
90 uint8_t classmark2_len;
91 uint8_t classmark2[3];
92 uint8_t classmark3_len;
93 uint8_t classmark3[14]; /* if cm3 gets extended by spec, it will be truncated */
94};
95
Harald Welte519c7e12018-01-28 02:45:46 +010096enum subscr_sccp_state {
97 SUBSCR_SCCP_ST_NONE,
98 SUBSCR_SCCP_ST_WAIT_CONN_CONF,
99 SUBSCR_SCCP_ST_CONNECTED
100};
101
Sylvain Munautaa824922019-03-07 16:32:02 +0100102enum channel_rate {
103 CH_RATE_SDCCH,
104 CH_RATE_HALF,
105 CH_RATE_FULL,
106};
107
Philipp Maierbb66d102019-01-22 11:29:06 +0100108struct channel_mode_and_rate {
109 enum gsm48_chan_mode chan_mode;
Sylvain Munautaa824922019-03-07 16:32:02 +0100110 enum channel_rate chan_rate;
Philipp Maierbb66d102019-01-22 11:29:06 +0100111 uint16_t s15_s0;
112};
113
Neels Hofmeyr7cfdbe72019-02-06 01:30:19 +0100114/* Information retrieved during an Assignment Request from the MSC. This is storage of the Assignment instructions
115 * parsed from the Assignment Request message, to pass on until the gscon and assignment FSMs have decided whether an
116 * Assignment is actually going to be carried out. Should remain unchanged after initial decoding. */
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200117struct assignment_request {
118 bool aoip;
119
120 uint16_t msc_assigned_cic;
121
122 char msc_rtp_addr[INET_ADDRSTRLEN];
123 uint16_t msc_rtp_port;
Pau Espin Pedrol83c0f762019-04-16 20:05:32 +0200124 bool use_osmux;
125 uint8_t osmux_cid;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200126
Sylvain Munautaa824922019-03-07 16:32:02 +0100127 /* Rate/codec setting in preference order (need at least 1 !) */
128 int n_ch_mode_rate;
129 struct channel_mode_and_rate ch_mode_rate[3];
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200130};
131
Neels Hofmeyr7cfdbe72019-02-06 01:30:19 +0100132/* State of an ongoing Assignment, while the assignment_fsm is still busy. This serves as state separation to keep the
133 * currently used lchan and gscon unmodified until the outcome of an Assignment is known. If the Assignment fails, this
134 * state is simply discarded, and the gscon carries on with the original lchan remaining unchanged. */
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200135struct assignment_fsm_data {
136 struct assignment_request req;
137 bool requires_voice_stream;
138
139 struct osmo_fsm_inst *fi;
140 struct gsm_lchan *new_lchan;
141
142 /* Whether this assignment triggered creation of the MGW endpoint: if the assignment
143 * fails, we will release that again as soon as possible. (If false, the endpoint already
144 * existed before or isn't needed at all.)*/
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +0200145 struct osmo_mgcpc_ep_ci *created_ci_for_msc;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200146
147 enum gsm0808_cause failure_cause;
148 enum gsm48_rr_cause rr_cause;
149
150 bool result_rate_ctr_done;
151};
152
153enum hodec_id {
154 HODEC_NONE,
155 HODEC1 = 1,
156 HODEC2 = 2,
157 HODEC_USER,
158 HODEC_REMOTE,
159};
160
161/* For example, to count specific kinds of ongoing handovers, it is useful to be able to OR-combine
162 * scopes. */
163enum handover_scope {
164 HO_NO_HANDOVER = 0,
165 HO_INTRA_CELL = 0x1,
166 HO_INTRA_BSC = 0x2,
167 HO_INTER_BSC_OUT = 0x4,
168 HO_INTER_BSC_IN = 0x8,
169 HO_SCOPE_ALL = 0xffff,
170};
171
172extern const struct value_string handover_scope_names[];
173inline static const char *handover_scope_name(enum handover_scope val)
174{ return get_value_string(handover_scope_names, val); }
175
176struct handover_out_req {
177 enum hodec_id from_hodec_id;
178 struct gsm_lchan *old_lchan;
179 struct neighbor_ident_key target_nik;
180 enum gsm_chan_t new_lchan_type; /*< leave GSM_LCHAN_NONE to use same as old_lchan */
181};
182
183struct handover_in_req {
184 struct gsm0808_channel_type ct;
185 struct gsm0808_speech_codec_list scl;
186 struct gsm0808_encrypt_info ei;
187 struct gsm_classmark classmark;
Neels Hofmeyrc15f6cd2019-03-15 02:48:39 +0100188 /* chosen_encr_alg reflects the encoded value as in RSL_ENC_ALG_A5(a5_numer):
189 * chosen_encr_alg == 1 means A5/0 i.e. no encryption, chosen_encr_alg == 4 means A5/3.
190 * chosen_encr_alg == 0 means no such IE was present. */
191 uint8_t chosen_encr_alg;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200192 struct gsm0808_cell_id cell_id_serving;
193 char cell_id_serving_name[64];
194 struct gsm0808_cell_id cell_id_target;
195 char cell_id_target_name[64];
196 uint16_t msc_assigned_cic;
197 char msc_assigned_rtp_addr[INET_ADDRSTRLEN];
198 uint16_t msc_assigned_rtp_port;
199};
200
201struct handover {
202 struct osmo_fsm_inst *fi;
203
204 enum hodec_id from_hodec_id;
205 enum handover_scope scope;
206 enum gsm_chan_t new_lchan_type;
207 struct neighbor_ident_key target_cell;
208
209 uint8_t ho_ref;
210 struct gsm_bts *new_bts;
211 struct gsm_lchan *new_lchan;
212 bool async;
213 struct handover_in_req inter_bsc_in;
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +0200214 struct osmo_mgcpc_ep_ci *created_ci_for_msc;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200215};
216
Neels Hofmeyr378a4922016-05-09 21:07:43 +0200217/* active radio connection of a mobile subscriber */
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100218struct gsm_subscriber_connection {
Harald Weltea43e0b42016-06-19 18:06:02 +0200219 /* global linked list of subscriber_connections */
Holger Hans Peter Freyther79f763f2010-09-16 00:53:37 +0800220 struct llist_head entry;
221
Harald Welte3561bd42018-01-28 03:04:16 +0100222 /* FSM instance to control the subscriber connection state (RTP, A) */
223 struct osmo_fsm_inst *fi;
224
Harald Weltea43e0b42016-06-19 18:06:02 +0200225 /* libbsc subscriber information (if available) */
Neels Hofmeyr6d804b12017-02-18 22:20:46 +0100226 struct bsc_subscr *bsub;
227
Holger Hans Peter Freyther18b63f42010-03-23 07:52:17 +0100228 /* back pointers */
Neels Hofmeyr5e0b0a62016-05-09 22:33:01 +0200229 struct gsm_network *network;
230
Neels Hofmeyr7cfdbe72019-02-06 01:30:19 +0100231 /* the primary / currently active lchan to the BTS/subscriber. During Assignment and Handover, separate lchans
232 * are kept in the .assignment or .handover sub-structs, respectively, so that this lchan remains unaffected
233 * until Assignment or Handover have actually succeeded. */
Harald Welte4a8ebc82017-12-18 18:34:41 +0100234 struct gsm_lchan *lchan;
Harald Welte3561bd42018-01-28 03:04:16 +0100235
Neels Hofmeyr7cfdbe72019-02-06 01:30:19 +0100236 /* Only valid during an ongoing Assignment; might be overwritten at any time by a failed Assignment attempt.
237 * Once an Assignment was successful, all relevant state must be copied out of this sub-struct. */
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200238 struct assignment_fsm_data assignment;
Holger Hans Peter Freyther77cd95d2010-11-14 16:19:48 +0100239
Neels Hofmeyr7cfdbe72019-02-06 01:30:19 +0100240 /* handover information, if a handover is pending for this conn. Valid only during an ongoing Handover
241 * operation. If a Handover was successful, all relevant state must be copied out of this sub-struct. */
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200242 struct handover ho;
Holger Hans Peter Freyther77cd95d2010-11-14 16:19:48 +0100243
Neels Hofmeyr149160f2018-06-16 17:20:13 +0200244 /* Queue DTAP messages during handover/assignment (msgb_enqueue()/msgb_dequeue())*/
245 struct llist_head dtap_queue;
246 unsigned int dtap_queue_len;
Andreas Eversberg084b4212013-05-30 14:12:48 +0200247
Neels Hofmeyrec422642018-02-15 14:07:40 +0100248 struct {
Neels Hofmeyr909e9722017-12-07 03:54:01 +0100249 int failures;
Neels Hofmeyrec422642018-02-15 14:07:40 +0100250 struct penalty_timers *penalty_timers;
251 } hodec2;
Neels Hofmeyra60f3442018-02-12 16:44:32 +0100252
253 /* "Codec List (MSC Preferred)" as received by the BSSAP Assignment Request. 3GPP 48.008
254 * 3.2.2.103 says:
255 * The "Codec List (MSC Preferred)" shall not include codecs
256 * that are not supported by the MS.
257 * i.e. by heeding the "Codec list (MSC Preferred)", we inherently heed the MS bearer
258 * capabilities, which the MSC is required to translate into the codec list. */
259 struct gsm0808_speech_codec_list codec_list;
Harald Welte519c7e12018-01-28 02:45:46 +0100260
261 /* flag to prevent multiple simultaneous ciphering commands */
262 int ciphering_handled;
263
264 /* state related to welcome USSD */
265 uint8_t new_subscriber;
266
Harald Welte519c7e12018-01-28 02:45:46 +0100267 /* SCCP connection associatd with this subscriber_connection */
268 struct {
269 /* for advanced ping/pong */
270 int send_ping;
271
Martin Haukea29affd2019-11-13 22:10:41 +0100272 /* SCCP connection related */
Harald Welte519c7e12018-01-28 02:45:46 +0100273 struct bsc_msc_data *msc;
274
275 /* Sigtran connection ID */
276 int conn_id;
277 enum subscr_sccp_state state;
278 } sccp;
279
280 /* for audio handling */
281 struct {
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200282 uint16_t msc_assigned_cic;
Harald Welte519c7e12018-01-28 02:45:46 +0100283
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200284 /* RTP address where the MSC expects us to send the RTP stream coming from the BTS. */
285 char msc_assigned_rtp_addr[INET_ADDRSTRLEN];
286 uint16_t msc_assigned_rtp_port;
Harald Welte519c7e12018-01-28 02:45:46 +0100287
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200288 /* The endpoint at the MGW used to join both BTS and MSC side connections, e.g.
289 * "rtpbridge/23@mgw". */
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +0200290 struct osmo_mgcpc_ep *mgw_endpoint;
Harald Welte3561bd42018-01-28 03:04:16 +0100291
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +0200292 /* The connection identifier of the osmo_mgcpc_ep used to transceive RTP towards the MSC.
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200293 * (The BTS side CI is handled by struct gsm_lchan and the lchan_fsm.) */
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +0200294 struct osmo_mgcpc_ep_ci *mgw_endpoint_ci_msc;
Harald Welte519c7e12018-01-28 02:45:46 +0100295 } user_plane;
Harald Weltec997ceb2018-05-30 01:39:43 +0200296
297 /* LCLS (local call, local switch) related state */
298 struct {
299 uint8_t global_call_ref[15];
300 uint8_t global_call_ref_len; /* length of global_call_ref */
Maxfe65ece2018-11-09 13:36:11 +0100301 enum gsm0808_lcls_config config; /* TS 48.008 3.2.2.116 */
302 enum gsm0808_lcls_control control; /* TS 48.008 3.2.2.117 */
Harald Weltec997ceb2018-05-30 01:39:43 +0200303 /* LCLS FSM */
304 struct osmo_fsm_inst *fi;
305 /* pointer to "other" connection, if Call Leg Relocation was successful */
306 struct gsm_subscriber_connection *other;
307 } lcls;
Pau Espin Pedrol7950e5d2019-10-31 15:59:49 +0100308
309 /* MS Power Class, TS 05.05 sec 4.1.1 "Mobile station". 0 means unset. */
310 uint8_t ms_power_class:3;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100311};
312
Harald Weltef142c972011-05-24 13:25:38 +0200313
Neels Hofmeyr10485162018-02-13 23:22:03 +0100314/* 16 is the max. number of SI2quater messages according to 3GPP TS 44.018 Table 10.5.2.33b.1:
315 4-bit index is used (2#1111 = 10#15) */
316#define SI2Q_MAX_NUM 16
317/* length in bits (for single SI2quater message) */
318#define SI2Q_MAX_LEN 160
319#define SI2Q_MIN_LEN 18
320
321struct osmo_bsc_data;
322
323struct osmo_bsc_sccp_con;
324
325/* Channel Request reason */
326enum gsm_chreq_reason_t {
327 GSM_CHREQ_REASON_EMERG,
328 GSM_CHREQ_REASON_PAG,
329 GSM_CHREQ_REASON_CALL,
330 GSM_CHREQ_REASON_LOCATION_UPD,
331 GSM_CHREQ_REASON_OTHER,
332 GSM_CHREQ_REASON_PDCH,
333};
334
335/* lchans 0..3 are SDCCH in combined channel configuration,
336 use 4 as magic number for BCCH hack - see osmo-bts-../oml.c:opstart_compl() */
337#define CCCH_LCHAN 4
338
339#define TRX_NR_TS 8
340#define TS_MAX_LCHAN 8
341
342#define HARDCODED_ARFCN 123
343#define HARDCODED_BSIC 0x3f /* NCC = 7 / BCC = 7 */
344
345/* for multi-drop config */
346#define HARDCODED_BTS0_TS 1
347#define HARDCODED_BTS1_TS 6
348#define HARDCODED_BTS2_TS 11
349
350#define MAX_VERSION_LENGTH 64
351
Neels Hofmeyr10485162018-02-13 23:22:03 +0100352enum gsm_hooks {
353 GSM_HOOK_NM_SWLOAD,
354 GSM_HOOK_RR_PAGING,
355 GSM_HOOK_RR_SECURITY,
356};
357
Neels Hofmeyr10485162018-02-13 23:22:03 +0100358enum bts_gprs_mode {
359 BTS_GPRS_NONE = 0,
360 BTS_GPRS_GPRS = 1,
361 BTS_GPRS_EGPRS = 2,
362};
363
364struct gsm_lchan;
365struct osmo_rtp_socket;
366struct rtp_socket;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100367
368/* Network Management State */
369struct gsm_nm_state {
370 uint8_t operational;
371 uint8_t administrative;
372 uint8_t availability;
373};
374
375struct gsm_abis_mo {
376 uint8_t obj_class;
377 uint8_t procedure_pending;
378 struct abis_om_obj_inst obj_inst;
379 const char *name;
380 struct gsm_nm_state nm_state;
381 struct tlv_parsed *nm_attr;
382 struct gsm_bts *bts;
383};
384
385/* Ericsson OM2000 Managed Object */
386struct abis_om2k_mo {
387 uint8_t class;
388 uint8_t bts;
389 uint8_t assoc_so;
390 uint8_t inst;
391} __attribute__ ((packed));
392
393struct om2k_mo {
394 struct abis_om2k_mo addr;
395 struct osmo_fsm_inst *fsm;
396};
397
398#define A38_XOR_MIN_KEY_LEN 12
399#define A38_XOR_MAX_KEY_LEN 16
400#define A38_COMP128_KEY_LEN 16
401#define RSL_ENC_ALG_A5(x) (x+1)
402#define MAX_EARFCN_LIST 32
403
404/* is the data link established? who established it? */
405#define LCHAN_SAPI_UNUSED 0
406#define LCHAN_SAPI_MS 1
407#define LCHAN_SAPI_NET 2
Neels Hofmeyr10485162018-02-13 23:22:03 +0100408
409/* BTS ONLY */
410#define MAX_NUM_UL_MEAS 104
411#define LC_UL_M_F_L1_VALID (1 << 0)
412#define LC_UL_M_F_RES_VALID (1 << 1)
413
414struct bts_ul_meas {
415 /* BER in units of 0.01%: 10.000 == 100% ber, 0 == 0% ber */
416 uint16_t ber10k;
417 /* timing advance offset (in quarter bits) */
418 int16_t ta_offs_qbits;
419 /* C/I ratio in dB */
420 float c_i;
421 /* flags */
422 uint8_t is_sub:1;
423 /* RSSI in dBm * -1 */
424 uint8_t inv_rssi;
425};
426
427struct bts_codec_conf {
428 uint8_t hr;
429 uint8_t efr;
430 uint8_t amr;
431};
432
433struct amr_mode {
434 uint8_t mode;
435 uint8_t threshold;
436 uint8_t hysteresis;
437};
438
439struct amr_multirate_conf {
440 uint8_t gsm48_ie[2];
441 struct amr_mode ms_mode[4];
442 struct amr_mode bts_mode[4];
443 uint8_t num_modes;
444};
445/* /BTS ONLY */
446
447enum lchan_csd_mode {
448 LCHAN_CSD_M_NT,
449 LCHAN_CSD_M_T_1200_75,
450 LCHAN_CSD_M_T_600,
451 LCHAN_CSD_M_T_1200,
452 LCHAN_CSD_M_T_2400,
453 LCHAN_CSD_M_T_9600,
454 LCHAN_CSD_M_T_14400,
455 LCHAN_CSD_M_T_29000,
456 LCHAN_CSD_M_T_32000,
457};
458
459/* State of the SAPIs in the lchan */
460enum lchan_sapi_state {
461 LCHAN_SAPI_S_NONE,
462 LCHAN_SAPI_S_REQ,
463 LCHAN_SAPI_S_ASSIGNED,
464 LCHAN_SAPI_S_REL,
465 LCHAN_SAPI_S_ERROR,
466};
467
Neels Hofmeyr92b9f2e2018-02-14 00:19:11 +0100468#define MAX_A5_KEY_LEN (128/8)
469
470struct gsm_encr {
471 uint8_t alg_id;
472 uint8_t key_len;
473 uint8_t key[MAX_A5_KEY_LEN];
474};
475
Neels Hofmeyr8da22332018-04-11 01:43:41 +0200476#define LOGPLCHAN(lchan, ss, level, fmt, args...) \
477 LOGP(ss, level, "%s (ss=%d,%s) (%s) " fmt, \
478 lchan ? gsm_ts_and_pchan_name(lchan->ts) : "-", \
479 lchan ? lchan->nr : 0, \
480 lchan ? gsm_lchant_name(lchan->type) : "-", \
481 bsc_subscr_name(lchan && lchan->conn ? lchan->conn->bsub : NULL), \
482 ## args)
483
Pau Espin Pedrold3e8e0c2018-11-28 16:35:10 +0100484/* Iterate lchans that have an FSM allocated based based on explicit pchan kind
485 * (GSM_PCHAN_* constant).
486 * Remark: PDCH related lchans are not handled in BSC but in PCU, so trying to
487 * iterate through GSM_PCHAN_PDCH is considered a void loop.
488 */
489#define ts_as_pchan_for_each_lchan(lchan, ts, as_pchan) \
490 for (lchan = (ts)->lchan; \
491 ((lchan - (ts)->lchan) < ARRAY_SIZE((ts)->lchan)) \
492 && lchan->fi \
493 && lchan->nr < pchan_subslots(as_pchan); \
494 lchan++)
495
Pau Espin Pedrol7ae0f9c2018-11-28 16:37:37 +0100496/* Iterate lchans that have an FSM allocated based on current PCHAN
497 * mode set in \ref ts.
498 * usage:
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200499 * struct gsm_lchan *lchan;
500 * struct gsm_bts_trx_ts *ts = get_some_timeslot();
501 * ts_for_each_lchan(lchan, ts) {
502 * LOGPLCHAN(DMAIN, LOGL_DEBUG, "hello world\n");
503 * }
Pau Espin Pedrol7ae0f9c2018-11-28 16:37:37 +0100504 */
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200505#define ts_for_each_lchan(lchan, ts) ts_as_pchan_for_each_lchan(lchan, ts, (ts)->pchan_is)
506
Pau Espin Pedrol0ba20df2018-11-28 16:39:29 +0100507/* Iterate over all possible lchans available that have an FSM allocated based
508 * on PCHAN \ref ts (dynamic) configuration.
509 * Iterate all lchan instances set up by this \ref ts type, including those
510 * lchans currently disabled or in process of being enabled (e.g. due to dynamic
511 * timeslot in switchover). Compare ts_for_each_lchan(), which iterates only the
512 * enabled lchans.
513 * For example, it is useful in case dynamic timeslot \ref ts is in process of
514 * switching from configuration PDCH (no lchans) to TCH_F (1 lchan), where
515 * pchan_is is still set to PDCH but \ref ts may contain already an \ref lchan
516 * of type TCH_F which initiated the request to switch the \ts configuration.
517 */
518#define ts_for_each_potential_lchan(lchan, ts) ts_as_pchan_for_each_lchan(lchan, ts, (ts)->pchan_on_init)
519
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200520enum lchan_activate_mode {
521 FOR_NONE,
522 FOR_MS_CHANNEL_REQUEST,
523 FOR_ASSIGNMENT,
524 FOR_HANDOVER,
525 FOR_VTY,
526};
527
528extern const struct value_string lchan_activate_mode_names[];
529static inline const char *lchan_activate_mode_name(enum lchan_activate_mode activ_for)
530{ return get_value_string(lchan_activate_mode_names, activ_for); }
531
Neels Hofmeyr700e5182018-12-19 17:19:02 +0100532struct lchan_activate_info {
533 enum lchan_activate_mode activ_for;
534 struct gsm_subscriber_connection *for_conn;
535 /* This always is for a specific lchan, so its lchan->type indicates full or half rate.
536 * When a dyn TS was selected, the lchan->type has been set to the desired rate. */
537 enum gsm48_chan_mode chan_mode;
Neels Hofmeyr58cf1b12019-03-15 02:49:18 +0100538 struct gsm_encr encr;
Neels Hofmeyr38134ea2018-12-21 03:01:00 +0100539 /* AMR config */
Neels Hofmeyr700e5182018-12-19 17:19:02 +0100540 uint16_t s15_s0;
541 bool requires_voice_stream;
542 bool wait_before_switching_rtp; /*< true = requires LCHAN_EV_READY_TO_SWITCH_RTP */
543 uint16_t msc_assigned_cic;
Neels Hofmeyr38134ea2018-12-21 03:01:00 +0100544 /* During intra-BSC handover, we keep the MGW endpoint intact and just re-route to the new lchan. This
545 * 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 +0100546 struct gsm_lchan *re_use_mgw_endpoint_from_lchan;
547};
548
Neels Hofmeyr10485162018-02-13 23:22:03 +0100549struct gsm_lchan {
550 /* The TS that we're part of */
551 struct gsm_bts_trx_ts *ts;
552 /* The logical subslot number in the TS */
553 uint8_t nr;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200554 char *name;
555
Neels Hofmeyreee24eb2018-11-06 21:39:15 +0100556 char *last_error;
557
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200558 struct osmo_fsm_inst *fi;
Neels Hofmeyrac85b342018-07-12 21:23:26 +0200559 struct osmo_fsm_inst *fi_rtp;
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +0200560 struct osmo_mgcpc_ep_ci *mgw_endpoint_ci_bts;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200561
562 struct {
Neels Hofmeyr700e5182018-12-19 17:19:02 +0100563 struct lchan_activate_info info;
Neels Hofmeyrac85b342018-07-12 21:23:26 +0200564 bool activ_ack; /*< true as soon as RSL Chan Activ Ack is received */
Neels Hofmeyr369fba22018-11-27 01:30:50 +0100565 bool immediate_assignment_sent;
Neels Hofmeyr193c1e32018-08-27 22:06:24 +0200566 /*! This flag ensures that when an lchan activation has succeeded, and we have already
567 * sent ACKs like Immediate Assignment or BSSMAP Assignment Complete, and if other errors
568 * occur later, e.g. during release, that we don't send a NACK out of context. */
569 bool concluded;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200570 enum gsm0808_cause gsm0808_error_cause;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200571 } activate;
572
Neels Hofmeyreee24eb2018-11-06 21:39:15 +0100573 struct {
574 /* If an event to release the lchan comes in while still waiting for responses, just mark this
575 * flag, so that the lchan will gracefully release at the next sensible junction. */
576 bool requested;
577 bool do_rr_release;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200578
Neels Hofmeyreee24eb2018-11-06 21:39:15 +0100579 /* There is an RSL error cause of value 0, so we need a separate flag. */
580 bool in_error;
581 /* RSL error code, RSL_ERR_* */
582 uint8_t rsl_error_cause;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200583
Neels Hofmeyreee24eb2018-11-06 21:39:15 +0100584 /* If a release event is being handled, ignore other ricocheting release events until that
585 * release handling has concluded. */
586 bool in_release_handler;
Harald Welte963763d2019-02-03 12:11:12 +0100587
588 /* is this release at the end of a CSFB call? */
589 bool is_csfb;
Neels Hofmeyreee24eb2018-11-06 21:39:15 +0100590 } release;
Neels Hofmeyrd5df9a12018-07-20 05:35:47 +0200591
Neels Hofmeyr10485162018-02-13 23:22:03 +0100592 /* The logical channel type */
593 enum gsm_chan_t type;
594 /* RSL channel mode */
595 enum rsl_cmod_spd rsl_cmode;
596 /* If TCH, traffic channel mode */
597 enum gsm48_chan_mode tch_mode;
598 enum lchan_csd_mode csd_mode;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100599 /* Power levels for MS and BTS */
600 uint8_t bs_power;
601 uint8_t ms_power;
602 /* Encryption information */
603 struct gsm_encr encr;
604
605 /* AMR bits */
606 uint8_t mr_ms_lv[7];
607 uint8_t mr_bts_lv[7];
Neels Hofmeyr4daa2102019-01-30 16:46:58 +0100608 /* AMR bits were based on these rate bits: */
609 uint16_t s15_s0;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100610
611 /* Established data link layer services */
612 uint8_t sapis[8];
613
614 struct {
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200615 uint32_t bound_ip; /*< where the BTS receives RTP */
Neels Hofmeyr10485162018-02-13 23:22:03 +0100616 uint16_t bound_port;
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200617 uint32_t connect_ip; /*< where the BTS sends RTP to (MGW) */
Neels Hofmeyr10485162018-02-13 23:22:03 +0100618 uint16_t connect_port;
619 uint16_t conn_id;
620 uint8_t rtp_payload;
621 uint8_t rtp_payload2;
622 uint8_t speech_mode;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100623
624 /* info we need to postpone the AoIP
625 * assignment completed message */
626 struct {
627 uint8_t rr_cause;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100628 bool valid;
629 } ass_compl;
630 } abis_ip;
631
632 uint8_t rqd_ta;
633
Neels Hofmeyr10485162018-02-13 23:22:03 +0100634 /* table of neighbor cell measurements */
635 struct neigh_meas_proc neigh_meas[MAX_NEIGH_MEAS];
636
637 /* cache of last measurement reports on this lchan */
638 struct gsm_meas_rep meas_rep[MAX_MEAS_REP];
639 int meas_rep_idx;
640 int meas_rep_count;
Neels Hofmeyr35ba85c2018-02-12 16:47:40 +0100641 uint8_t meas_rep_last_seen_nr;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100642
643 /* GSM Random Access data */
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200644 /* TODO: don't allocate this, rather keep an "is_present" flag */
Neels Hofmeyr10485162018-02-13 23:22:03 +0100645 struct gsm48_req_ref *rqd_ref;
646
647 struct gsm_subscriber_connection *conn;
Philipp Maierbb66d102019-01-22 11:29:06 +0100648
649 /* Depending on the preferences that where submitted together with
650 * the assignment and the current channel load, the BSC has to select
651 * one of the offered codec/rates. The final selection by the BSC is
652 * stored here and is used when sending the assignment complete or
653 * when performing a handover procedure. */
654 struct channel_mode_and_rate ch_mode_rate;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100655};
656
Neels Hofmeyr10485162018-02-13 23:22:03 +0100657/* One Timeslot in a TRX */
658struct gsm_bts_trx_ts {
659 struct gsm_bts_trx *trx;
660 /* number of this timeslot at the TRX */
661 uint8_t nr;
662
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200663 struct osmo_fsm_inst *fi;
664 char *last_errmsg;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100665
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200666 /* vty phys_chan_config setting, not necessarily in effect in case it was changed in the telnet
667 * vty after OML activation. Gets written on vty 'write file'. */
668 enum gsm_phys_chan_config pchan_from_config;
669 /* When the timeslot OML is established, pchan_from_config is copied here. This is the pchan
670 * currently in effect; for dynamic ts, this is the dyn kind (GSM_PCHAN_TCH_F_TCH_H_PDCH or
671 * GSM_PCHAN_TCH_F_PDCH) and does not show the pchan type currently active. */
672 enum gsm_phys_chan_config pchan_on_init;
673 /* This is the *actual* pchan type currently active. For dynamic timeslots, this reflects either
674 * GSM_PCHAN_NONE or one of the standard GSM_PCHAN_TCH_F, GSM_PCHAN_TCH_H, GSM_PCHAN_PDCH.
675 * Callers can use this transparently without being aware of dyn ts. */
676 enum gsm_phys_chan_config pchan_is;
Neels Hofmeyr10485162018-02-13 23:22:03 +0100677
Neels Hofmeyr31f525e2018-05-14 18:14:15 +0200678 /* After a PDCH ACT NACK, we shall not infinitely loop to try and ACT again.
679 * Also marks a timeslot where PDCH was deactivated by VTY. This is cleared whenever a timeslot
680 * enters IN_USE state, i.e. after each TCH use we try to PDCH ACT once again. */
681 bool pdch_act_allowed;
682
Neels Hofmeyrbcdbfb72018-07-26 20:33:15 +0200683 /* Whether TS_EV_OML_READY was received */
684 bool is_oml_ready;
685 /* Whether TS_EV_RSL_READY was received */
686 bool is_rsl_ready;
687
Neels Hofmeyr10485162018-02-13 23:22:03 +0100688 struct gsm_abis_mo mo;
689 struct tlv_parsed nm_attr;
690 uint8_t nm_chan_comb;
691 int tsc; /* -1 == use BTS TSC */
692
693 struct {
694 /* Parameters below are configured by VTY */
695 int enabled;
696 uint8_t maio;
697 uint8_t hsn;
698 struct bitvec arfcns;
699 uint8_t arfcns_data[1024/8];
700 /* This is the pre-computed MA for channel assignments */
701 struct bitvec ma;
702 uint8_t ma_len; /* part of ma_data that is used */
703 uint8_t ma_data[8]; /* 10.5.2.21: max 8 bytes value part */
704 } hopping;
705
706 /* To which E1 subslot are we connected */
707 struct gsm_e1_subslot e1_link;
708
709 union {
710 struct {
711 struct om2k_mo om2k_mo;
712 } rbs2000;
713 };
714
715 struct gsm_lchan lchan[TS_MAX_LCHAN];
716};
717
718/* One TRX in a BTS */
719struct gsm_bts_trx {
720 /* list header in bts->trx_list */
721 struct llist_head list;
722
723 struct gsm_bts *bts;
724 /* number of this TRX in the BTS */
725 uint8_t nr;
726 /* human readable name / description */
727 char *description;
728 /* how do we talk RSL with this TRX? */
729 struct gsm_e1_subslot rsl_e1_link;
730 uint8_t rsl_tei;
731 struct e1inp_sign_link *rsl_link;
732
733 /* Timeout for initiating the RSL connection. */
734 struct osmo_timer_list rsl_connect_timeout;
735
736 /* Some BTS (specifically Ericsson RBS) have a per-TRX OML Link */
737 struct e1inp_sign_link *oml_link;
738
739 struct gsm_abis_mo mo;
740 struct tlv_parsed nm_attr;
741 struct {
742 struct gsm_abis_mo mo;
743 } bb_transc;
744
745 uint16_t arfcn;
746 int nominal_power; /* in dBm */
747 unsigned int max_power_red; /* in actual dB */
748
749 union {
750 struct {
751 struct {
752 struct gsm_abis_mo mo;
753 } bbsig;
754 struct {
755 struct gsm_abis_mo mo;
756 } pa;
757 } bs11;
758 struct {
759 unsigned int test_state;
760 uint8_t test_nr;
761 struct rxlev_stats rxlev_stat;
762 } ipaccess;
763 struct {
764 struct {
765 struct om2k_mo om2k_mo;
766 } trxc;
767 struct {
768 struct om2k_mo om2k_mo;
769 } rx;
770 struct {
771 struct om2k_mo om2k_mo;
772 } tx;
773 } rbs2000;
774 };
775 struct gsm_bts_trx_ts ts[TRX_NR_TS];
776};
777
778#define GSM_BTS_SI2Q(bts, i) (struct gsm48_system_information_type_2quater *)((bts)->si_buf[SYSINFO_TYPE_2quater][i])
779#define GSM_BTS_HAS_SI(bts, i) ((bts)->si_valid & (1 << i))
780#define GSM_BTS_SI(bts, i) (void *)((bts)->si_buf[i][0])
781#define GSM_LCHAN_SI(lchan, i) (void *)((lchan)->si.buf[i][0])
782
783enum gsm_bts_type {
784 GSM_BTS_TYPE_UNKNOWN,
785 GSM_BTS_TYPE_BS11,
786 GSM_BTS_TYPE_NANOBTS,
787 GSM_BTS_TYPE_RBS2000,
788 GSM_BTS_TYPE_NOKIA_SITE,
789 GSM_BTS_TYPE_OSMOBTS,
790 _NUM_GSM_BTS_TYPE
791};
792
793enum gsm_bts_type_variant {
794 BTS_UNKNOWN,
795 BTS_OSMO_LITECELL15,
796 BTS_OSMO_OCTPHY,
797 BTS_OSMO_SYSMO,
798 BTS_OSMO_TRX,
799 _NUM_BTS_VARIANT
800};
801
802/* Used by OML layer for BTS Attribute reporting */
803enum bts_attribute {
804 BTS_TYPE_VARIANT,
805 BTS_SUB_MODEL,
806 TRX_PHY_VERSION,
807};
808
809struct vty;
810
811struct gsm_bts_model {
812 struct llist_head list;
813
814 enum gsm_bts_type type;
815 enum gsm_bts_type_variant variant;
816 const char *name;
817
818 bool started;
819 int (*start)(struct gsm_network *net);
820 int (*oml_rcvmsg)(struct msgb *msg);
821 char * (*oml_status)(const struct gsm_bts *bts);
822
823 void (*e1line_bind_ops)(struct e1inp_line *line);
824
825 void (*config_write_bts)(struct vty *vty, struct gsm_bts *bts);
826 void (*config_write_trx)(struct vty *vty, struct gsm_bts_trx *trx);
827 void (*config_write_ts)(struct vty *vty, struct gsm_bts_trx_ts *ts);
828
Pau Espin Pedrol167cb822018-11-19 17:48:17 +0100829 /* Should SI2bis and SI2ter be disabled by default on this BTS model? */
830 bool force_combined_si;
831
Neels Hofmeyr10485162018-02-13 23:22:03 +0100832 struct tlv_definition nm_att_tlvdef;
833
834 /* features of a given BTS model set via gsm_bts_model_register() locally */
835 struct bitvec features;
836 uint8_t _features_data[MAX_BTS_FEATURES/8];
837};
838
Neels Hofmeyr10485162018-02-13 23:22:03 +0100839
Neels Hofmeyr10485162018-02-13 23:22:03 +0100840
841/*
842 * This keeps track of the paging status of one BTS. It
843 * includes a number of pending requests, a back pointer
844 * to the gsm_bts, a timer and some more state.
845 */
846struct gsm_bts_paging_state {
847 /* pending requests */
848 struct llist_head pending_requests;
849 struct gsm_bts *bts;
850
851 struct osmo_timer_list work_timer;
852 struct osmo_timer_list credit_timer;
853
854 /* free chans needed */
855 int free_chans_need;
856
857 /* load */
858 uint16_t available_slots;
859};
860
861struct gsm_envabtse {
862 struct gsm_abis_mo mo;
863};
864
865struct gsm_bts_gprs_nsvc {
866 struct gsm_bts *bts;
867 /* data read via VTY config file, to configure the BTS
868 * via OML from BSC */
869 int id;
870 uint16_t nsvci;
871 uint16_t local_port; /* on the BTS */
872 uint16_t remote_port; /* on the SGSN */
873 uint32_t remote_ip; /* on the SGSN */
874
875 struct gsm_abis_mo mo;
876};
877
878enum gprs_rlc_par {
879 RLC_T3142,
880 RLC_T3169,
881 RLC_T3191,
882 RLC_T3193,
883 RLC_T3195,
884 RLC_N3101,
885 RLC_N3103,
886 RLC_N3105,
887 CV_COUNTDOWN,
888 T_DL_TBF_EXT, /* ms */
889 T_UL_TBF_EXT, /* ms */
890 _NUM_RLC_PAR
891};
892
893enum gprs_cs {
894 GPRS_CS1,
895 GPRS_CS2,
896 GPRS_CS3,
897 GPRS_CS4,
898 GPRS_MCS1,
899 GPRS_MCS2,
900 GPRS_MCS3,
901 GPRS_MCS4,
902 GPRS_MCS5,
903 GPRS_MCS6,
904 GPRS_MCS7,
905 GPRS_MCS8,
906 GPRS_MCS9,
907 _NUM_GRPS_CS
908};
909
910struct gprs_rlc_cfg {
911 uint16_t parameter[_NUM_RLC_PAR];
912 struct {
913 uint16_t repeat_time; /* ms */
914 uint8_t repeat_count;
915 } paging;
916 uint32_t cs_mask; /* bitmask of gprs_cs */
917 uint8_t initial_cs;
918 uint8_t initial_mcs;
919};
920
921
922enum neigh_list_manual_mode {
923 NL_MODE_AUTOMATIC = 0,
924 NL_MODE_MANUAL = 1,
925 NL_MODE_MANUAL_SI5SEP = 2, /* SI2 and SI5 have separate neighbor lists */
926};
927
928enum bts_loc_fix {
929 BTS_LOC_FIX_INVALID = 0,
930 BTS_LOC_FIX_2D = 1,
931 BTS_LOC_FIX_3D = 2,
932};
933
934extern const struct value_string bts_loc_fix_names[];
935
936struct bts_location {
937 struct llist_head list;
938 time_t tstamp;
939 enum bts_loc_fix valid;
940 double lat;
941 double lon;
942 double height;
943};
944
945/* Channel load counter */
946struct load_counter {
947 unsigned int total;
948 unsigned int used;
949};
950
Neels Hofmeyr19bed232018-03-22 04:54:57 +0100951/* Useful to track N-N relations between BTS, for example neighbors. */
952struct gsm_bts_ref {
953 struct llist_head entry;
954 struct gsm_bts *bts;
955};
956
Harald Welted41b7c72019-06-13 09:41:58 +0200957/* A single Page of a SMSCB message */
958struct bts_smscb_page {
959 /* SMSCB message we're part of */
960 struct bts_smscb_message *msg;
961 /* Page Number within message (1 to 15) */
962 uint8_t nr;
963 /* number of valid blocks in data (up to 4) */
964 uint8_t num_blocks;
965 /* up to four blocks of 22 bytes each */
966 uint8_t data[88];
967};
968
969/* A SMSCB message (received from CBSP) */
970struct bts_smscb_message {
971 /* entry in bts_smscb_chan_state.messages */
972 struct llist_head list;
973 struct {
974 /* input data from CBSP (CBC) side */
975 uint16_t msg_id;
976 uint16_t serial_nr;
977 enum cbsp_category category;
978 uint16_t rep_period;
979 uint16_t num_bcast_req;
980 uint8_t dcs;
981 } input;
982 /* how often have all pages of this message been broadcast? */
983 uint32_t bcast_count;
984 /* actual page data of this message */
985 uint8_t num_pages; /* up to 15 */
986 struct bts_smscb_page page[15];
987};
988
989/* per-channel (basic/extended) CBCH state for a single BTS */
990struct bts_smscb_chan_state {
991 /* back-pointer to BTS */
992 struct gsm_bts *bts;
993 /* list of bts_smscb_message */
994 struct llist_head messages;
995 /* scheduling array; pointer of SMSCB pages */
996 struct bts_smscb_page **sched_arr;
997 size_t sched_arr_size;
998 /* index of the next to be transmitted page into the scheduler array */
999 size_t next_idx;
1000 /* number of messages we have to pause due to overflow */
1001 uint8_t overflow;
1002};
1003
Oliver Smithba0a1222020-03-18 12:39:30 +01001004struct bts_oml_fail_rep {
1005 struct llist_head list;
1006 time_t time;
1007 struct msgb *mb;
1008};
1009
Neels Hofmeyr10485162018-02-13 23:22:03 +01001010/* One BTS */
1011struct gsm_bts {
1012 /* list header in net->bts_list */
1013 struct llist_head list;
1014
1015 /* Geographical location of the BTS */
1016 struct llist_head loc_list;
1017
Martin Haukea29affd2019-11-13 22:10:41 +01001018 /* number of this BTS in network */
Neels Hofmeyr10485162018-02-13 23:22:03 +01001019 uint8_t nr;
1020 /* human readable name / description */
1021 char *description;
1022 /* Cell Identity */
1023 uint16_t cell_identity;
1024 /* location area code of this BTS */
1025 uint16_t location_area_code;
1026 /* Base Station Identification Code (BSIC), lower 3 bits is BCC,
1027 * which is used as TSC for the CCCH */
1028 uint8_t bsic;
1029 /* type of BTS */
1030 enum gsm_bts_type type;
1031 enum gsm_bts_type_variant variant;
1032 struct gsm_bts_model *model;
1033 enum gsm_band band;
1034 char version[MAX_VERSION_LENGTH];
1035 char sub_model[MAX_VERSION_LENGTH];
1036
1037 /* features of a given BTS set/reported via OML */
1038 struct bitvec features;
1039 uint8_t _features_data[MAX_BTS_FEATURES/8];
1040
1041 /* Connected PCU version (if any) */
1042 char pcu_version[MAX_VERSION_LENGTH];
1043
1044 /* maximum Tx power that the MS is permitted to use in this cell */
1045 int ms_max_power;
1046
1047 /* how do we talk OML with this TRX? */
1048 struct gsm_e1_subslot oml_e1_link;
1049 uint8_t oml_tei;
1050 struct e1inp_sign_link *oml_link;
Pau Espin Pedrol9862bcb2018-08-22 21:54:12 +02001051 /* Timer to use for deferred drop of OML link, see \ref ipaccess_drop_oml_deferred */
1052 struct osmo_timer_list oml_drop_link_timer;
Neels Hofmeyr10485162018-02-13 23:22:03 +01001053 /* when OML link was established */
1054 time_t uptime;
1055
1056 /* Abis network management O&M handle */
1057 struct abis_nm_h *nmh;
1058
1059 struct gsm_abis_mo mo;
1060
1061 /* number of this BTS on given E1 link */
1062 uint8_t bts_nr;
1063
1064 /* DTX features of this BTS */
1065 enum gsm48_dtx_mode dtxu;
1066 bool dtxd;
1067
1068 /* paging state and control */
1069 struct gsm_bts_paging_state paging;
1070
1071 /* CCCH is on C0 */
1072 struct gsm_bts_trx *c0;
1073
1074 struct {
1075 struct gsm_abis_mo mo;
1076 } site_mgr;
1077
1078 /* bitmask of all SI that are present/valid in si_buf */
1079 uint32_t si_valid;
1080 /* 3GPP TS 44.018 Table 10.5.2.33b.1 INDEX and COUNT for SI2quater */
1081 uint8_t si2q_index; /* distinguish individual SI2quater messages */
1082 uint8_t si2q_count; /* si2q_index for the last (highest indexed) individual SI2quater message */
1083 /* buffers where we put the pre-computed SI */
1084 sysinfo_buf_t si_buf[_MAX_SYSINFO_TYPE][SI2Q_MAX_NUM];
1085 /* offsets used while generating SI2quater */
1086 size_t e_offset;
1087 size_t u_offset;
Pau Espin Pedrol1cf21de2018-12-05 13:38:10 +01001088 /* 3GPP TS 08.58 §8.5.1 BCCH INFORMATION. Some nanoBTS fail upon
1089 * receival of empty SI disabling unsupported SI. see OS#3707. */
1090 bool si_unused_send_empty;
Neels Hofmeyr10485162018-02-13 23:22:03 +01001091
Martin Haukea29affd2019-11-13 22:10:41 +01001092 /* ip.access Unit ID's have Site/BTS/TRX layout */
Neels Hofmeyr10485162018-02-13 23:22:03 +01001093 union {
1094 struct {
1095 uint16_t site_id;
1096 uint16_t bts_id;
1097 uint32_t flags;
1098 uint32_t rsl_ip;
1099 } ip_access;
1100 struct {
1101 struct {
1102 struct gsm_abis_mo mo;
1103 } cclk;
1104 struct {
1105 struct gsm_abis_mo mo;
1106 } rack;
1107 struct gsm_envabtse envabtse[4];
1108 } bs11;
1109 struct {
1110 struct {
1111 struct om2k_mo om2k_mo;
1112 struct gsm_abis_mo mo;
1113 struct llist_head conn_groups;
1114 } cf;
1115 struct {
1116 struct om2k_mo om2k_mo;
1117 struct gsm_abis_mo mo;
1118 struct llist_head conn_groups;
1119 } is;
1120 struct {
1121 struct om2k_mo om2k_mo;
1122 struct gsm_abis_mo mo;
1123 struct llist_head conn_groups;
1124 } con;
1125 struct {
1126 struct om2k_mo om2k_mo;
1127 struct gsm_abis_mo mo;
1128 } dp;
1129 struct {
1130 struct om2k_mo om2k_mo;
1131 struct gsm_abis_mo mo;
1132 } tf;
Sylvain Munautcbaa1792020-05-05 20:14:44 +02001133 struct {
1134 struct om2k_mo om2k_mo;
1135 struct gsm_abis_mo mo;
1136 } mctr;
Neels Hofmeyr10485162018-02-13 23:22:03 +01001137 uint32_t use_superchannel:1;
Sylvain Munautdbd1b502020-05-05 21:07:58 +02001138 struct {
1139 uint16_t limit;
1140 uint16_t active;
1141 } om2k_version[16];
Neels Hofmeyr10485162018-02-13 23:22:03 +01001142 } rbs2000;
1143 struct {
1144 uint8_t bts_type;
Harald Welte1d7349f2020-05-03 11:48:31 +02001145 unsigned int configured:1, /* we sent the config data request */
1146 skip_reset:1, /* skip reset at bootstrap */
1147 no_loc_rel_cnf:1, /* don't wait for RSL REL CONF */
1148 bts_reset_timer_cnf, /* timer for BTS RESET */
1149 did_reset:1, /* we received a RESET ACK */
Harald Welte456a62e2020-05-03 12:00:52 +02001150 wait_reset:2; /* we are waiting for reset to complete */
Neels Hofmeyr10485162018-02-13 23:22:03 +01001151 struct osmo_timer_list reset_timer;
1152 } nokia;
1153 };
1154
1155 /* Not entirely sure how ip.access specific this is */
1156 struct {
Neels Hofmeyr10485162018-02-13 23:22:03 +01001157 enum bts_gprs_mode mode;
1158 struct {
1159 struct gsm_abis_mo mo;
1160 uint16_t nsei;
1161 uint8_t timer[7];
1162 } nse;
1163 struct {
1164 struct gsm_abis_mo mo;
1165 uint16_t bvci;
1166 uint8_t timer[11];
1167 struct gprs_rlc_cfg rlc_cfg;
1168 } cell;
1169 struct gsm_bts_gprs_nsvc nsvc[2];
1170 uint8_t rac;
1171 uint8_t net_ctrl_ord;
1172 bool ctrl_ack_type_use_block;
Vadim Yanitskiye981f172020-04-06 18:09:55 +07001173 bool egprs_pkt_chan_request;
Neels Hofmeyr10485162018-02-13 23:22:03 +01001174 } gprs;
1175
Harald Welte15400252019-05-24 11:56:23 +02001176 /* threshold (in percent) when BTS shall send CCCH LOAD IND */
1177 int ccch_load_ind_thresh;
1178
Neels Hofmeyr10485162018-02-13 23:22:03 +01001179 /* RACH NM values */
1180 int rach_b_thresh;
1181 int rach_ldavg_slots;
1182
1183 /* transceivers */
1184 int num_trx;
1185 struct llist_head trx_list;
1186
1187 /* SI related items */
1188 int force_combined_si;
Pau Espin Pedrol167cb822018-11-19 17:48:17 +01001189 bool force_combined_si_set;
Neels Hofmeyr10485162018-02-13 23:22:03 +01001190 int bcch_change_mark;
1191
1192 /* Abis NM queue */
1193 struct llist_head abis_queue;
1194 int abis_nm_pend;
1195
1196 struct gsm_network *network;
1197
1198 /* should the channel allocator allocate channels from high TRX to TRX0,
1199 * rather than starting from TRX0 and go upwards? */
1200 int chan_alloc_reverse;
1201
1202 enum neigh_list_manual_mode neigh_list_manual_mode;
1203 /* parameters from which we build SYSTEM INFORMATION */
1204 struct {
1205 struct gsm48_rach_control rach_control;
1206 uint8_t ncc_permitted;
1207 struct gsm48_cell_sel_par cell_sel_par;
1208 struct gsm48_si_selection_params cell_ro_sel_par; /* rest octet */
1209 struct gsm48_cell_options cell_options;
1210 struct gsm48_control_channel_descr chan_desc;
1211 struct bitvec neigh_list;
1212 struct bitvec cell_alloc;
1213 struct bitvec si5_neigh_list;
1214 struct osmo_earfcn_si2q si2quater_neigh_list;
1215 size_t uarfcn_length; /* index for uarfcn and scramble lists */
1216 struct {
1217 /* bitmask large enough for all possible ARFCN's */
1218 uint8_t neigh_list[1024/8];
1219 uint8_t cell_alloc[1024/8];
1220 /* If the user wants a different neighbor list in SI5 than in SI2 */
1221 uint8_t si5_neigh_list[1024/8];
1222 uint8_t meas_bw_list[MAX_EARFCN_LIST];
1223 uint16_t earfcn_list[MAX_EARFCN_LIST];
1224 uint16_t uarfcn_list[MAX_EARFCN_LIST];
1225 uint16_t scramble_list[MAX_EARFCN_LIST];
1226 } data;
1227 } si_common;
1228 bool early_classmark_allowed;
1229 bool early_classmark_allowed_3g;
1230 /* for testing only: Have an infinitely long radio link timeout */
1231 bool infinite_radio_link_timeout;
1232
1233 /* do we use static (user-defined) system information messages? (bitmask) */
1234 uint32_t si_mode_static;
1235
Stefan Sperling6442e432018-02-06 14:44:54 +01001236 /* access control class ramping */
1237 struct acc_ramp acc_ramp;
1238
Neels Hofmeyr10485162018-02-13 23:22:03 +01001239 /* exclude the BTS from the global RF Lock handling */
1240 int excl_from_rf_lock;
1241
1242 /* supported codecs beside FR */
1243 struct bts_codec_conf codec;
1244
1245 /* BTS dependencies bit field */
1246 uint32_t depends_on[256/(8*4)];
1247
1248 /* full and half rate multirate config */
1249 struct amr_multirate_conf mr_full;
1250 struct amr_multirate_conf mr_half;
1251
1252 /* PCU socket state */
1253 char *pcu_sock_path;
1254 struct pcu_sock_state *pcu_state;
1255
1256 struct rate_ctr_group *bts_ctrs;
1257 struct osmo_stat_item_group *bts_statg;
1258
1259 struct handover_cfg *ho;
1260
Neels Hofmeyr19bed232018-03-22 04:54:57 +01001261 /* A list of struct gsm_bts_ref, indicating neighbors of this BTS.
1262 * When the si_common neigh_list is in automatic mode, it is populated from this list as well as
1263 * gsm_network->neighbor_bss_cells. */
1264 struct llist_head local_neighbors;
1265
Neels Hofmeyr10485162018-02-13 23:22:03 +01001266 /* BTS-specific overrides for timer values from struct gsm_network. */
Martin Haukea29affd2019-11-13 22:10:41 +01001267 uint8_t T3122; /* ASSIGNMENT REJECT wait indication */
Pau Espin Pedrol1b963342018-11-07 14:19:32 +01001268 bool T3113_dynamic; /* Calculate T3113 timeout dynamically based on BTS channel config and load */
Neels Hofmeyr10485162018-02-13 23:22:03 +01001269
1270 /* Periodic channel load measurements are used to maintain T3122. */
1271 struct load_counter chan_load_samples[7];
1272 int chan_load_samples_idx;
Stefan Sperling6442e432018-02-06 14:44:54 +01001273 uint8_t chan_load_avg; /* current channel load average in percent (0 - 100). */
Harald Welted41b7c72019-06-13 09:41:58 +02001274
1275 /* cell broadcast system */
1276 struct osmo_timer_list cbch_timer;
1277 struct bts_smscb_chan_state cbch_basic;
1278 struct bts_smscb_chan_state cbch_extended;
Harald Welte7d888442019-09-06 23:18:27 +02001279 struct osmo_timer_list etws_timer; /* when to stop ETWS PN */
Oliver Smithba0a1222020-03-18 12:39:30 +01001280
1281 struct llist_head oml_fail_rep;
Neels Hofmeyr10485162018-02-13 23:22:03 +01001282};
1283
Oliver Smith8d8d7102018-10-23 15:35:43 +02001284/* One rejected BTS */
1285struct gsm_bts_rejected {
1286 /* list header in net->bts_rejected */
1287 struct llist_head list;
1288
1289 uint16_t site_id;
1290 uint16_t bts_id;
1291 char ip[INET6_ADDRSTRLEN];
1292 time_t time;
1293};
Neels Hofmeyr10485162018-02-13 23:22:03 +01001294
Neels Hofmeyr958f2592018-05-27 01:26:31 +02001295struct gsm_network *gsm_network_init(void *ctx);
1296
Neels Hofmeyr10485162018-02-13 23:22:03 +01001297struct gsm_bts *gsm_bts_alloc(struct gsm_network *net, uint8_t bts_num);
Neels Hofmeyr6d568ed2018-07-09 16:49:18 +02001298struct gsm_bts *gsm_bts_num(const struct gsm_network *net, int num);
Neels Hofmeyr19bed232018-03-22 04:54:57 +01001299bool gsm_bts_matches_lai(const struct gsm_bts *bts, const struct osmo_location_area_id *lai);
1300bool gsm_bts_matches_cell_id(const struct gsm_bts *bts, const struct gsm0808_cell_id *cell_id);
1301struct gsm_bts *gsm_bts_by_cell_id(const struct gsm_network *net,
1302 const struct gsm0808_cell_id *cell_id,
1303 int match_idx);
1304int gsm_bts_local_neighbor_add(struct gsm_bts *bts, struct gsm_bts *neighbor);
1305int gsm_bts_local_neighbor_del(struct gsm_bts *bts, const struct gsm_bts *neighbor);
Neels Hofmeyr10485162018-02-13 23:22:03 +01001306
1307struct gsm_bts_trx *gsm_bts_trx_alloc(struct gsm_bts *bts);
1308struct gsm_bts_trx *gsm_bts_trx_num(const struct gsm_bts *bts, int num);
1309
1310enum gsm_bts_type str2btstype(const char *arg);
1311const char *btstype2str(enum gsm_bts_type type);
1312
1313enum bts_attribute str2btsattr(const char *s);
1314const char *btsatttr2str(enum bts_attribute v);
1315
1316enum gsm_bts_type_variant str2btsvariant(const char *arg);
1317const char *btsvariant2str(enum gsm_bts_type_variant v);
1318
1319extern const struct value_string gsm_chreq_descs[];
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001320extern const struct value_string gsm_pchant_names[];
1321extern const struct value_string gsm_pchant_descs[];
1322extern const struct value_string gsm_pchan_ids[];
Neels Hofmeyr10485162018-02-13 23:22:03 +01001323const char *gsm_pchan_name(enum gsm_phys_chan_config c);
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001324static inline const char *gsm_pchan_id(enum gsm_phys_chan_config c)
1325{ return get_value_string(gsm_pchan_ids, c); }
Neels Hofmeyr10485162018-02-13 23:22:03 +01001326enum gsm_phys_chan_config gsm_pchan_parse(const char *name);
1327const char *gsm_lchant_name(enum gsm_chan_t c);
1328const char *gsm_chreq_name(enum gsm_chreq_reason_t c);
Harald Welte57658ec2019-02-04 12:30:44 +01001329char *gsm_bts_name(const struct gsm_bts *bts);
Neels Hofmeyr10485162018-02-13 23:22:03 +01001330char *gsm_trx_name(const struct gsm_bts_trx *trx);
1331char *gsm_ts_name(const struct gsm_bts_trx_ts *ts);
1332char *gsm_ts_and_pchan_name(const struct gsm_bts_trx_ts *ts);
1333char *gsm_lchan_name_compute(const struct gsm_lchan *lchan);
Neels Hofmeyr10485162018-02-13 23:22:03 +01001334
1335static inline char *gsm_lchan_name(const struct gsm_lchan *lchan)
1336{
1337 return lchan->name;
1338}
1339
Neels Hofmeyr10485162018-02-13 23:22:03 +01001340void gsm_abis_mo_reset(struct gsm_abis_mo *mo);
1341
1342struct gsm_nm_state *
1343gsm_objclass2nmstate(struct gsm_bts *bts, uint8_t obj_class,
1344 const struct abis_om_obj_inst *obj_inst);
1345void *
1346gsm_objclass2obj(struct gsm_bts *bts, uint8_t obj_class,
1347 const struct abis_om_obj_inst *obj_inst);
1348
1349/* reset the state of all MO in the BTS */
1350void gsm_bts_mo_reset(struct gsm_bts *bts);
1351
1352uint8_t gsm_pchan2chan_nr(enum gsm_phys_chan_config pchan,
1353 uint8_t ts_nr, uint8_t lchan_nr);
1354uint8_t gsm_lchan2chan_nr(const struct gsm_lchan *lchan);
1355uint8_t gsm_lchan_as_pchan2chan_nr(const struct gsm_lchan *lchan,
1356 enum gsm_phys_chan_config as_pchan);
1357
Harald Welte251bec12018-09-09 17:14:09 +02001358void gsm48_lchan2chan_desc(struct gsm48_chan_desc *cd,
1359 const struct gsm_lchan *lchan);
Harald Welte24286f32018-09-09 17:17:44 +02001360void gsm48_lchan2chan_desc_as_configured(struct gsm48_chan_desc *cd, const struct gsm_lchan *lchan);
Harald Welte251bec12018-09-09 17:14:09 +02001361
Neels Hofmeyr10485162018-02-13 23:22:03 +01001362/* return the gsm_lchan for the CBCH (if it exists at all) */
1363struct gsm_lchan *gsm_bts_get_cbch(struct gsm_bts *bts);
1364
1365/*
1366 * help with parsing regexps
1367 */
1368int gsm_parse_reg(void *ctx, regex_t *reg, char **str,
1369 int argc, const char **argv) __attribute__ ((warn_unused_result));
1370
1371static inline uint8_t gsm_ts_tsc(const struct gsm_bts_trx_ts *ts)
1372{
1373 if (ts->tsc != -1)
1374 return ts->tsc;
1375 else
1376 return ts->trx->bts->bsic & 7;
1377}
1378
1379struct gsm_lchan *rsl_lchan_lookup(struct gsm_bts_trx *trx, uint8_t chan_nr,
1380 int *rc);
1381
1382enum gsm_phys_chan_config ts_pchan(struct gsm_bts_trx_ts *ts);
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001383uint8_t pchan_subslots(enum gsm_phys_chan_config pchan);
Neels Hofmeyr10485162018-02-13 23:22:03 +01001384bool ts_is_tch(struct gsm_bts_trx_ts *ts);
1385
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +01001386
Harald Welteb7948872017-12-18 18:48:21 +01001387static inline struct gsm_bts *conn_get_bts(struct gsm_subscriber_connection *conn) {
1388 OSMO_ASSERT(conn->lchan);
1389 return conn->lchan->ts->trx->bts;
1390}
1391
Pau Espin Pedrol7950e5d2019-10-31 15:59:49 +01001392void conn_update_ms_power_class(struct gsm_subscriber_connection *conn, uint8_t power_class);
1393void lchan_update_ms_power_ctrl_level(struct gsm_lchan *lchan, int ms_power_dbm);
1394
Alexander Chemeris5d638272020-05-11 00:30:11 +03001395enum bts_counter_id {
Harald Welted82101e2017-12-09 23:07:38 +01001396 BTS_CTR_CHREQ_TOTAL,
1397 BTS_CTR_CHREQ_NO_CHANNEL,
1398 BTS_CTR_CHAN_RF_FAIL,
1399 BTS_CTR_CHAN_RLL_ERR,
1400 BTS_CTR_BTS_OML_FAIL,
1401 BTS_CTR_BTS_RSL_FAIL,
1402 BTS_CTR_CODEC_AMR_F,
1403 BTS_CTR_CODEC_AMR_H,
1404 BTS_CTR_CODEC_EFR,
1405 BTS_CTR_CODEC_V1_FR,
1406 BTS_CTR_CODEC_V1_HR,
Harald Weltecf9d4312017-12-13 23:17:16 +01001407 BTS_CTR_PAGING_ATTEMPTED,
1408 BTS_CTR_PAGING_ALREADY,
1409 BTS_CTR_PAGING_RESPONDED,
1410 BTS_CTR_PAGING_EXPIRED,
Alexander Chemeris43def742020-05-16 18:49:59 +03001411 BTS_CTR_PAGING_NO_ACTIVE_PAGING,
Harald Welte4f598922017-12-14 13:47:02 +01001412 BTS_CTR_CHAN_ACT_TOTAL,
1413 BTS_CTR_CHAN_ACT_NACK,
Harald Welte62d9cb02017-12-14 14:00:26 +01001414 BTS_CTR_RSL_UNKNOWN,
Harald Welte581398a2017-12-14 14:29:44 +01001415 BTS_CTR_RSL_IPA_NACK,
Harald Welte00d64fd2017-12-14 14:34:16 +01001416 BTS_CTR_MODE_MODIFY_NACK,
Alexander Chemeris5d638272020-05-11 00:30:11 +03001417 BTS_CTR_LCHAN_BORKEN_FROM_UNUSED,
1418 BTS_CTR_LCHAN_BORKEN_FROM_WAIT_ACTIV_ACK,
1419 BTS_CTR_LCHAN_BORKEN_FROM_WAIT_RF_RELEASE_ACK,
1420 BTS_CTR_LCHAN_BORKEN_FROM_BORKEN,
1421 BTS_CTR_LCHAN_BORKEN_FROM_UNKNOWN,
1422 BTS_CTR_LCHAN_BORKEN_EV_CHAN_ACTIV_ACK,
1423 BTS_CTR_LCHAN_BORKEN_EV_CHAN_ACTIV_NACK,
1424 BTS_CTR_LCHAN_BORKEN_EV_RF_CHAN_REL_ACK,
1425 BTS_CTR_LCHAN_BORKEN_EV_VTY,
1426 BTS_CTR_LCHAN_BORKEN_EV_TEARDOWN,
1427 BTS_CTR_TS_BORKEN_FROM_NOT_INITIALIZED,
1428 BTS_CTR_TS_BORKEN_FROM_UNUSED,
1429 BTS_CTR_TS_BORKEN_FROM_WAIT_PDCH_ACT,
1430 BTS_CTR_TS_BORKEN_FROM_PDCH,
1431 BTS_CTR_TS_BORKEN_FROM_WAIT_PDCH_DEACT,
1432 BTS_CTR_TS_BORKEN_FROM_IN_USE,
1433 BTS_CTR_TS_BORKEN_FROM_BORKEN,
1434 BTS_CTR_TS_BORKEN_FROM_UNKNOWN,
1435 BTS_CTR_TS_BORKEN_EV_PDCH_ACT_ACK_NACK,
1436 BTS_CTR_TS_BORKEN_EV_PDCH_DEACT_ACK_NACK,
1437 BTS_CTR_TS_BORKEN_EV_TEARDOWN,
Harald Welted82101e2017-12-09 23:07:38 +01001438};
1439
1440static const struct rate_ctr_desc bts_ctr_description[] = {
Harald Welte1ef46d92017-12-09 23:10:46 +01001441 [BTS_CTR_CHREQ_TOTAL] = {"chreq:total", "Received channel requests."},
1442 [BTS_CTR_CHREQ_NO_CHANNEL] = {"chreq:no_channel", "Sent to MS no channel available."},
1443 [BTS_CTR_CHAN_RF_FAIL] = {"chan:rf_fail", "Received a RF failure indication from BTS."},
1444 [BTS_CTR_CHAN_RLL_ERR] = {"chan:rll_err", "Received a RLL failure with T200 cause from BTS."},
Harald Welted82101e2017-12-09 23:07:38 +01001445 [BTS_CTR_BTS_OML_FAIL] = {"oml_fail", "Received a TEI down on a OML link."},
1446 [BTS_CTR_BTS_RSL_FAIL] = {"rsl_fail", "Received a TEI down on a OML link."},
Harald Welte1ef46d92017-12-09 23:10:46 +01001447 [BTS_CTR_CODEC_AMR_F] = {"codec:amr_f", "Count the usage of AMR/F codec by channel mode requested."},
1448 [BTS_CTR_CODEC_AMR_H] = {"codec:amr_h", "Count the usage of AMR/H codec by channel mode requested."},
1449 [BTS_CTR_CODEC_EFR] = {"codec:efr", "Count the usage of EFR codec by channel mode requested."},
1450 [BTS_CTR_CODEC_V1_FR] = {"codec:fr", "Count the usage of FR codec by channel mode requested."},
1451 [BTS_CTR_CODEC_V1_HR] = {"codec:hr", "Count the usage of HR codec by channel mode requested."},
Harald Weltecf9d4312017-12-13 23:17:16 +01001452
1453 [BTS_CTR_PAGING_ATTEMPTED] = {"paging:attempted", "Paging attempts for a subscriber."},
Martin Haukea29affd2019-11-13 22:10:41 +01001454 [BTS_CTR_PAGING_ALREADY] = {"paging:already", "Paging attempts ignored as subscriber was already being paged."},
Harald Weltecf9d4312017-12-13 23:17:16 +01001455 [BTS_CTR_PAGING_RESPONDED] = {"paging:responded", "Paging attempts with successful paging response."},
1456 [BTS_CTR_PAGING_EXPIRED] = {"paging:expired", "Paging Request expired because of timeout T3113."},
Alexander Chemeris43def742020-05-16 18:49:59 +03001457 [BTS_CTR_PAGING_NO_ACTIVE_PAGING] = {"paging:no_active_paging", "Paging response without an active paging request (arrived after paging expiration?)."},
Harald Welte4f598922017-12-14 13:47:02 +01001458 [BTS_CTR_CHAN_ACT_TOTAL] = {"chan_act:total", "Total number of Channel Activations."},
1459 [BTS_CTR_CHAN_ACT_NACK] = {"chan_act:nack", "Number of Channel Activations that the BTS NACKed"},
Harald Welte62d9cb02017-12-14 14:00:26 +01001460 [BTS_CTR_RSL_UNKNOWN] = {"rsl:unknown", "Number of unknown/unsupported RSL messages received from BTS"},
Harald Welte581398a2017-12-14 14:29:44 +01001461 [BTS_CTR_RSL_IPA_NACK] = {"rsl:ipa_nack", "Number of IPA (RTP/dyn-PDCH) related NACKs received from BTS"},
Harald Welte00d64fd2017-12-14 14:34:16 +01001462 [BTS_CTR_MODE_MODIFY_NACK] = {"chan:mode_modify_nack", "Number of Channel Mode Modify NACKs received from BTS"},
Alexander Chemeris5d638272020-05-11 00:30:11 +03001463
1464 /* lchan/TS BORKEN state counters */
1465 [BTS_CTR_LCHAN_BORKEN_FROM_UNUSED] = {"lchan_borken:from_state:unused", "Transitions from lchan UNUSED state to BORKEN state"},
1466 [BTS_CTR_LCHAN_BORKEN_FROM_WAIT_ACTIV_ACK] = {"lchan_borken:from_state:wait_activ_ack", "Transitions from lchan WAIT_ACTIV_ACK state to BORKEN state"},
1467 [BTS_CTR_LCHAN_BORKEN_FROM_WAIT_RF_RELEASE_ACK] = {"lchan_borken:from_state:wait_rf_release_ack", "Transitions from lchan WAIT_RF_RELEASE_ACK state to BORKEN state"},
1468 [BTS_CTR_LCHAN_BORKEN_FROM_BORKEN] = {"lchan_borken:from_state:borken", "Transitions from lchan BORKEN state to BORKEN state"},
1469 [BTS_CTR_LCHAN_BORKEN_FROM_UNKNOWN] = {"lchan_borken:from_state:unknown", "Transitions from an unknown lchan state to BORKEN state"},
1470 [BTS_CTR_LCHAN_BORKEN_EV_CHAN_ACTIV_ACK] = {"lchan_borken:event:chan_activ_ack", "CHAN_ACTIV_ACK received in the lchan BORKEN state"},
1471 [BTS_CTR_LCHAN_BORKEN_EV_CHAN_ACTIV_NACK] = {"lchan_borken:event:chan_activ_nack", "CHAN_ACTIV_NACK received in the lchan BORKEN state"},
1472 [BTS_CTR_LCHAN_BORKEN_EV_RF_CHAN_REL_ACK] = {"lchan_borken:event:rf_chan_rel_ack", "RF_CHAN_REL_ACK received in the lchan BORKEN state"},
1473 [BTS_CTR_LCHAN_BORKEN_EV_VTY] = {"lchan_borken:event:vty", "VTY commands received in the lchan BORKEN state"},
1474 [BTS_CTR_LCHAN_BORKEN_EV_TEARDOWN] = {"lchan_borken:event:teardown", "lchan in a BORKEN state is shutting down (BTS disconnected?)"},
1475 [BTS_CTR_TS_BORKEN_FROM_NOT_INITIALIZED] = {"ts_borken:from_state:not_initialized", "Transitions from TS NOT_INITIALIZED state to BORKEN state"},
1476 [BTS_CTR_TS_BORKEN_FROM_UNUSED] = {"ts_borken:from_state:unused", "Transitions from TS UNUSED state to BORKEN state"},
1477 [BTS_CTR_TS_BORKEN_FROM_WAIT_PDCH_ACT] = {"ts_borken:from_state:wait_pdch_act", "Transitions from TS WAIT_PDCH_ACT state to BORKEN state"},
1478 [BTS_CTR_TS_BORKEN_FROM_PDCH] = {"ts_borken:from_state:pdch", "Transitions from TS PDCH state to BORKEN state"},
1479 [BTS_CTR_TS_BORKEN_FROM_WAIT_PDCH_DEACT] = {"ts_borken:from_state:wait_pdch_deact", "Transitions from TS WAIT_PDCH_DEACT state to BORKEN state"},
1480 [BTS_CTR_TS_BORKEN_FROM_IN_USE] = {"ts_borken:from_state:in_use", "Transitions from TS IN_USE state to BORKEN state"},
1481 [BTS_CTR_TS_BORKEN_FROM_BORKEN] = {"ts_borken:from_state:borken", "Transitions from TS BORKEN state to BORKEN state"},
1482 [BTS_CTR_TS_BORKEN_FROM_UNKNOWN] = {"ts_borken:from_state:unknown", "Transitions from an unknown TS state to BORKEN state"},
1483 [BTS_CTR_TS_BORKEN_EV_PDCH_ACT_ACK_NACK] = {"ts_borken:event:pdch_act_ack_nack", "PDCH_ACT_ACK/NACK received in the TS BORKEN state"},
1484 [BTS_CTR_TS_BORKEN_EV_PDCH_DEACT_ACK_NACK] = {"ts_borken:event:pdch_deact_ack_nack", "PDCH_DEACT_ACK/NACK received in the TS BORKEN state"},
1485 [BTS_CTR_TS_BORKEN_EV_TEARDOWN] = {"ts_borken:event:teardown", "TS in a BORKEN state is shutting down (BTS disconnected?)"},
Harald Welted82101e2017-12-09 23:07:38 +01001486};
1487
1488static const struct rate_ctr_group_desc bts_ctrg_desc = {
1489 "bts",
1490 "base transceiver station",
1491 OSMO_STATS_CLASS_GLOBAL,
1492 ARRAY_SIZE(bts_ctr_description),
1493 bts_ctr_description,
1494};
Holger Hans Peter Freyther5ba6f482009-10-28 14:23:39 +01001495
Alexander Couzens20423ea2016-07-12 15:42:02 +02001496enum {
Stefan Sperling81dc9e72018-02-05 17:34:36 +01001497 BTS_STAT_CHAN_LOAD_AVERAGE,
Alexander Chemerisb091def2020-05-06 23:17:49 +03001498 BTS_STAT_CHAN_CCCH_SDCCH4_USED,
1499 BTS_STAT_CHAN_CCCH_SDCCH4_TOTAL,
1500 BTS_STAT_CHAN_TCH_F_USED,
1501 BTS_STAT_CHAN_TCH_F_TOTAL,
1502 BTS_STAT_CHAN_TCH_H_USED,
1503 BTS_STAT_CHAN_TCH_H_TOTAL,
1504 BTS_STAT_CHAN_SDCCH8_USED,
1505 BTS_STAT_CHAN_SDCCH8_TOTAL,
1506 BTS_STAT_CHAN_TCH_F_PDCH_USED,
1507 BTS_STAT_CHAN_TCH_F_PDCH_TOTAL,
1508 BTS_STAT_CHAN_CCCH_SDCCH4_CBCH_USED,
1509 BTS_STAT_CHAN_CCCH_SDCCH4_CBCH_TOTAL,
1510 BTS_STAT_CHAN_SDCCH8_CBCH_USED,
1511 BTS_STAT_CHAN_SDCCH8_CBCH_TOTAL,
1512 BTS_STAT_CHAN_TCH_F_TCH_H_PDCH_USED,
1513 BTS_STAT_CHAN_TCH_F_TCH_H_PDCH_TOTAL,
Stefan Sperling81dc9e72018-02-05 17:34:36 +01001514 BTS_STAT_T3122,
Harald Weltebe86caa2019-05-24 09:30:28 +02001515 BTS_STAT_RACH_BUSY,
1516 BTS_STAT_RACH_ACCESS,
Alexander Chemeris8b0f6872020-05-07 16:46:47 +03001517 BTS_STAT_OML_CONNECTED,
1518 BTS_STAT_RSL_CONNECTED,
Alexander Chemeris5d638272020-05-11 00:30:11 +03001519 BTS_STAT_LCHAN_BORKEN,
1520 BTS_STAT_TS_BORKEN,
Stefan Sperling81dc9e72018-02-05 17:34:36 +01001521};
1522
1523enum {
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001524 BSC_CTR_ASSIGNMENT_ATTEMPTED,
1525 BSC_CTR_ASSIGNMENT_COMPLETED,
1526 BSC_CTR_ASSIGNMENT_STOPPED,
1527 BSC_CTR_ASSIGNMENT_NO_CHANNEL,
1528 BSC_CTR_ASSIGNMENT_TIMEOUT,
1529 BSC_CTR_ASSIGNMENT_FAILED,
1530 BSC_CTR_ASSIGNMENT_ERROR,
Alexander Couzensb847a212016-08-02 11:34:11 +02001531 BSC_CTR_HANDOVER_ATTEMPTED,
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001532 BSC_CTR_HANDOVER_COMPLETED,
1533 BSC_CTR_HANDOVER_STOPPED,
Alexander Couzensb847a212016-08-02 11:34:11 +02001534 BSC_CTR_HANDOVER_NO_CHANNEL,
1535 BSC_CTR_HANDOVER_TIMEOUT,
Alexander Couzensb847a212016-08-02 11:34:11 +02001536 BSC_CTR_HANDOVER_FAILED,
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001537 BSC_CTR_HANDOVER_ERROR,
1538 BSC_CTR_INTER_BSC_HO_OUT_ATTEMPTED,
1539 BSC_CTR_INTER_BSC_HO_OUT_COMPLETED,
1540 BSC_CTR_INTER_BSC_HO_OUT_STOPPED,
1541 BSC_CTR_INTER_BSC_HO_OUT_TIMEOUT,
1542 BSC_CTR_INTER_BSC_HO_OUT_ERROR,
1543 BSC_CTR_INTER_BSC_HO_IN_ATTEMPTED,
1544 BSC_CTR_INTER_BSC_HO_IN_COMPLETED,
1545 BSC_CTR_INTER_BSC_HO_IN_STOPPED,
1546 BSC_CTR_INTER_BSC_HO_IN_NO_CHANNEL,
1547 BSC_CTR_INTER_BSC_HO_IN_FAILED,
1548 BSC_CTR_INTER_BSC_HO_IN_TIMEOUT,
1549 BSC_CTR_INTER_BSC_HO_IN_ERROR,
Alexander Couzensb847a212016-08-02 11:34:11 +02001550 BSC_CTR_PAGING_ATTEMPTED,
1551 BSC_CTR_PAGING_DETACHED,
Harald Weltecf9d4312017-12-13 23:17:16 +01001552 BSC_CTR_PAGING_RESPONDED,
Alexander Chemeris43def742020-05-16 18:49:59 +03001553 BSC_CTR_PAGING_NO_ACTIVE_PAGING,
Stefan Sperling7926d982018-05-17 14:52:02 +02001554 BSC_CTR_UNKNOWN_UNIT_ID,
Alexander Couzensb847a212016-08-02 11:34:11 +02001555};
1556
1557static const struct rate_ctr_desc bsc_ctr_description[] = {
Neels Hofmeyrdbb38d52018-07-11 19:53:56 +02001558 [BSC_CTR_ASSIGNMENT_ATTEMPTED] = {"assignment:attempted", "Assignment attempts."},
1559 [BSC_CTR_ASSIGNMENT_COMPLETED] = {"assignment:completed", "Assignment completed."},
1560 [BSC_CTR_ASSIGNMENT_STOPPED] = {"assignment:stopped", "Connection ended during Assignment."},
1561 [BSC_CTR_ASSIGNMENT_NO_CHANNEL] = {"assignment:no_channel", "Failure to allocate lchan for Assignment."},
1562 [BSC_CTR_ASSIGNMENT_TIMEOUT] = {"assignment:timeout", "Assignment timed out."},
1563 [BSC_CTR_ASSIGNMENT_FAILED] = {"assignment:failed", "Received Assignment Failure message."},
Martin Haukea29affd2019-11-13 22:10:41 +01001564 [BSC_CTR_ASSIGNMENT_ERROR] = {"assignment:error", "Assignment failed for other reason."},
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001565
1566 [BSC_CTR_HANDOVER_ATTEMPTED] = {"handover:attempted", "Intra-BSC handover attempts."},
1567 [BSC_CTR_HANDOVER_COMPLETED] = {"handover:completed", "Intra-BSC handover completed."},
1568 [BSC_CTR_HANDOVER_STOPPED] = {"handover:stopped", "Connection ended during HO."},
1569 [BSC_CTR_HANDOVER_NO_CHANNEL] = {"handover:no_channel", "Failure to allocate lchan for HO."},
1570 [BSC_CTR_HANDOVER_TIMEOUT] = {"handover:timeout", "Handover timed out."},
1571 [BSC_CTR_HANDOVER_FAILED] = {"handover:failed", "Received Handover Fail messages."},
Martin Haukea29affd2019-11-13 22:10:41 +01001572 [BSC_CTR_HANDOVER_ERROR] = {"handover:error", "Re-assignment failed for other reason."},
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001573
1574 [BSC_CTR_INTER_BSC_HO_OUT_ATTEMPTED] = {"interbsc_ho_out:attempted",
1575 "Attempts to handover to remote BSS."},
1576 [BSC_CTR_INTER_BSC_HO_OUT_COMPLETED] = {"interbsc_ho_out:completed",
1577 "Handover to remote BSS completed."},
1578 [BSC_CTR_INTER_BSC_HO_OUT_STOPPED] = {"interbsc_ho_out:stopped", "Connection ended during HO."},
1579 [BSC_CTR_INTER_BSC_HO_OUT_TIMEOUT] = {"interbsc_ho_out:timeout", "Handover timed out."},
1580 [BSC_CTR_INTER_BSC_HO_OUT_ERROR] = {"interbsc_ho_out:error",
1581 "Handover to remote BSS failed for other reason."},
1582
1583 [BSC_CTR_INTER_BSC_HO_IN_ATTEMPTED] = {"interbsc_ho_in:attempted",
1584 "Attempts to handover from remote BSS."},
1585 [BSC_CTR_INTER_BSC_HO_IN_COMPLETED] = {"interbsc_ho_in:completed",
1586 "Handover from remote BSS completed."},
1587 [BSC_CTR_INTER_BSC_HO_IN_STOPPED] = {"interbsc_ho_in:stopped", "Connection ended during HO."},
1588 [BSC_CTR_INTER_BSC_HO_IN_NO_CHANNEL] = {"interbsc_ho_in:no_channel",
1589 "Failure to allocate lchan for HO."},
1590 [BSC_CTR_INTER_BSC_HO_IN_TIMEOUT] = {"interbsc_ho_in:timeout", "Handover from remote BSS timed out."},
1591 [BSC_CTR_INTER_BSC_HO_IN_FAILED] = {"interbsc_ho_in:failed", "Received Handover Fail message."},
1592 [BSC_CTR_INTER_BSC_HO_IN_ERROR] = {"interbsc_ho_in:error",
1593 "Handover from remote BSS failed for other reason."},
Harald Weltecf9d4312017-12-13 23:17:16 +01001594
1595 [BSC_CTR_PAGING_ATTEMPTED] = {"paging:attempted", "Paging attempts for a subscriber."},
Stefan Sperling71d524c2018-05-17 14:38:27 +02001596 [BSC_CTR_PAGING_DETACHED] = {"paging:detached", "Paging request send failures because no responsible BTS was found."},
Harald Weltecf9d4312017-12-13 23:17:16 +01001597 [BSC_CTR_PAGING_RESPONDED] = {"paging:responded", "Paging attempts with successful response."},
Alexander Chemeris43def742020-05-16 18:49:59 +03001598 [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 +02001599
1600 [BSC_CTR_UNKNOWN_UNIT_ID] = {"abis:unknown_unit_id", "Connection attempts from unknown IPA CCM Unit ID."},
Alexander Couzensb847a212016-08-02 11:34:11 +02001601};
1602
Alexander Couzensb847a212016-08-02 11:34:11 +02001603
1604
1605static const struct rate_ctr_group_desc bsc_ctrg_desc = {
1606 "bsc",
1607 "base station controller",
1608 OSMO_STATS_CLASS_GLOBAL,
1609 ARRAY_SIZE(bsc_ctr_description),
1610 bsc_ctr_description,
Alexander Couzens20423ea2016-07-12 15:42:02 +02001611};
1612
Alexander Chemerisdb542832020-05-08 01:49:12 +03001613/* Constants for the BSC stats */
1614enum {
1615 BSC_STAT_NUM_BTS_TOTAL,
1616};
1617
Neels Hofmeyr73983952016-05-10 13:29:33 +02001618struct gsm_tz {
1619 int override; /* if 0, use system's time zone instead. */
1620 int hr; /* hour */
1621 int mn; /* minute */
1622 int dst; /* daylight savings */
1623};
1624
Harald Welte52b1f982008-12-23 20:25:15 +00001625struct gsm_network {
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +02001626 /* TODO MSCSPLIT the gsm_network struct is basically a kitchen sink for
1627 * global settings and variables, "madly" mixing BSC and MSC stuff. Split
1628 * this in e.g. struct osmo_bsc and struct osmo_msc, with the things
1629 * these have in common, like country and network code, put in yet
1630 * separate structs and placed as members in osmo_bsc and osmo_msc. */
1631
Neels Hofmeyrf93970b2018-03-05 02:09:40 +01001632 struct osmo_plmn_id plmn;
1633
Harald Welte51e4bf32017-12-23 17:30:18 +01001634 /* bit-mask of permitted encryption algorithms. LSB=A5/0, MSB=A5/7 */
1635 uint8_t a5_encryption_mask;
Holger Hans Peter Freytherf7d752f2009-11-16 17:12:38 +01001636 int neci;
Neels Hofmeyr909e9722017-12-07 03:54:01 +01001637
Neels Hofmeyre25018b2017-11-27 21:29:33 +01001638 struct handover_cfg *ho;
Neels Hofmeyr909e9722017-12-07 03:54:01 +01001639 struct {
1640 unsigned int congestion_check_interval_s;
1641 struct osmo_timer_list congestion_check_timer;
1642 } hodec2;
Harald Welte52b1f982008-12-23 20:25:15 +00001643
Alexander Chemerisdb542832020-05-08 01:49:12 +03001644 /* structures for keeping rate counters and gauge stats */
Alexander Couzensb847a212016-08-02 11:34:11 +02001645 struct rate_ctr_group *bsc_ctrs;
Alexander Chemerisdb542832020-05-08 01:49:12 +03001646 struct osmo_stat_item_group *bsc_statg;
Harald Welte24ff6ee2009-12-22 00:41:05 +01001647
Harald Welte52b1f982008-12-23 20:25:15 +00001648 unsigned int num_bts;
Harald Weltee441d9c2009-06-21 16:17:15 +02001649 struct llist_head bts_list;
Oliver Smith8d8d7102018-10-23 15:35:43 +02001650 struct llist_head bts_rejected;
Holger Hans Peter Freytherc4d88ad2009-11-21 21:18:38 +01001651
Neels Hofmeyr08822a32019-07-11 03:43:34 +02001652 /* see gsm_network_T_defs */
Neels Hofmeyra6078fe2019-01-28 03:52:14 +01001653 struct osmo_tdef *T_defs;
Harald Welteeab84a12009-12-13 10:53:12 +01001654
Alexander Couzens547c2072017-11-21 12:03:04 +01001655 enum gsm_chan_t ctype_by_chreq[_NUM_CHREQ_T];
Holger Hans Peter Freyther78891072010-09-06 09:36:02 +08001656
Holger Hans Peter Freyther76fc4a32010-09-06 09:41:50 +08001657 /* Use a TCH for handling requests of type paging any */
1658 int pag_any_tch;
1659
Holger Hans Peter Freyther3e8e0462010-09-15 22:29:25 +08001660 /* MSC data in case we are a true BSC */
Holger Hans Peter Freyther8ec49522011-08-15 15:53:00 +02001661 struct osmo_bsc_data *bsc_data;
Holger Hans Peter Freytherdaee5ca2010-12-22 12:34:39 +01001662
Daniel Willmann6fc4a982011-07-22 17:55:42 +02001663 /* control interface */
1664 struct ctrl_handle *ctrl;
Neels Hofmeyr5f0c71b2016-07-23 20:15:28 +02001665
1666 /* Allow or disallow TCH/F on dynamic TCH/F_TCH/H_PDCH; OS#1778 */
1667 bool dyn_ts_allow_tch_f;
Neels Hofmeyrd90fa422016-05-09 21:03:12 +02001668
1669 /* all active subscriber connections. */
1670 struct llist_head subscr_conns;
Neels Hofmeyr73983952016-05-10 13:29:33 +02001671
1672 /* if override is nonzero, this timezone data is used for all MM
1673 * contexts. */
1674 /* TODO: in OsmoNITB, tz-override used to be BTS-specific. To enable
1675 * BTS|RNC specific timezone overrides for multi-tz networks in
Neels Hofmeyrfe291de2017-02-23 21:06:12 +01001676 * OsmoMSC, this should be tied to the location area code (LAC). */
Neels Hofmeyr73983952016-05-10 13:29:33 +02001677 struct gsm_tz tz;
Neels Hofmeyr6d804b12017-02-18 22:20:46 +01001678
1679 /* List of all struct bsc_subscr used in libbsc. This llist_head is
1680 * allocated so that the llist_head pointer itself can serve as a
1681 * talloc context (useful to not have to pass the entire gsm_network
1682 * struct to the bsc_subscr_* API, and for bsc_susbscr unit tests to
1683 * not require gsm_data.h). In an MSC-without-BSC environment, this
1684 * pointer is NULL to indicate absence of a bsc_subscribers list. */
1685 struct llist_head *bsc_subscribers;
Harald Weltea43e0b42016-06-19 18:06:02 +02001686
Stefan Sperling6cee8932018-01-30 18:14:22 +01001687 /* Timer for periodic channel load measurements to maintain each BTS's T3122. */
1688 struct osmo_timer_list t3122_chan_load_timer;
1689
Neels Hofmeyrc29505e2016-05-20 21:59:55 +02001690 struct {
Philipp Maier39c609b2017-09-27 15:51:34 +02001691 struct mgcp_client_conf *conf;
1692 struct mgcp_client *client;
Neels Hofmeyrf14aaa42019-04-23 18:37:37 +02001693 struct osmo_tdef *tdefs;
Philipp Maier39c609b2017-09-27 15:51:34 +02001694 } mgw;
Neels Hofmeyr19bed232018-03-22 04:54:57 +01001695
1696 /* Remote BSS Cell Identifier Lists */
1697 struct neighbor_ident_list *neighbor_bss_cells;
Oliver Smitha595db12020-03-17 12:21:00 +01001698
1699 /* Don't refuse to start with mutually exclusive codec settings */
1700 bool allow_unusable_timeslots;
Harald Welte7e310b12009-03-30 20:56:32 +00001701};
1702
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001703struct gsm_audio_support {
1704 uint8_t hr : 1,
1705 ver : 7;
1706};
1707
Neels Hofmeyrf93970b2018-03-05 02:09:40 +01001708static inline const struct osmo_location_area_id *bts_lai(struct gsm_bts *bts)
1709{
1710 static struct osmo_location_area_id lai;
1711 lai = (struct osmo_location_area_id){
1712 .plmn = bts->network->plmn,
1713 .lac = bts->location_area_code,
1714 };
1715 return &lai;
1716}
1717
Neels Hofmeyrc13e6872016-05-11 13:53:47 +02001718extern void talloc_ctx_init(void *ctx_root);
1719
Harald Welte39315c42010-01-10 18:01:52 +01001720int gsm_set_bts_type(struct gsm_bts *bts, enum gsm_bts_type type);
Harald Weltee441d9c2009-06-21 16:17:15 +02001721
Harald Welte1d014a52009-08-08 15:38:29 +02001722enum gsm_bts_type parse_btstype(const char *arg);
Holger Hans Peter Freyther2dceae62009-06-12 17:39:38 +02001723const char *btstype2str(enum gsm_bts_type type);
Harald Weltebe991492009-05-23 13:56:40 +00001724struct gsm_bts *gsm_bts_by_lac(struct gsm_network *net, unsigned int lac,
1725 struct gsm_bts *start_bts);
Harald Welte32201c12009-03-10 12:15:10 +00001726
Andreas Eversberg8226fa72009-06-29 15:19:38 +02001727extern void *tall_bsc_ctx;
Harald Welte2cf161b2009-06-20 22:36:41 +02001728
Martin Haukea29affd2019-11-13 22:10:41 +01001729/* this actually refers to the IPA transport, not the BTS model */
Harald Welte32201c12009-03-10 12:15:10 +00001730static inline int is_ipaccess_bts(struct gsm_bts *bts)
1731{
1732 switch (bts->type) {
Mike Habene2d82272009-10-02 12:19:34 +01001733 case GSM_BTS_TYPE_NANOBTS:
Maxf9685c12017-03-23 12:01:07 +01001734 case GSM_BTS_TYPE_OSMOBTS:
Harald Welte32201c12009-03-10 12:15:10 +00001735 return 1;
1736 default:
1737 break;
1738 }
1739 return 0;
1740}
1741
Holger Hans Peter Freyther6f6cbf72015-04-04 19:35:22 +02001742static inline int is_sysmobts_v2(struct gsm_bts *bts)
1743{
1744 switch (bts->type) {
Maxf9685c12017-03-23 12:01:07 +01001745 case GSM_BTS_TYPE_OSMOBTS:
Holger Hans Peter Freyther6f6cbf72015-04-04 19:35:22 +02001746 return 1;
1747 default:
1748 break;
1749 }
1750 return 0;
1751}
1752
Harald Welte5b570672009-08-10 10:08:01 +02001753static inline int is_siemens_bts(struct gsm_bts *bts)
1754{
1755 switch (bts->type) {
1756 case GSM_BTS_TYPE_BS11:
1757 return 1;
1758 default:
1759 break;
1760 }
1761
1762 return 0;
1763}
1764
Andreas Eversberg7d8fa342013-12-05 13:25:06 +01001765static inline int is_nokia_bts(struct gsm_bts *bts)
1766{
1767 switch (bts->type) {
1768 case GSM_BTS_TYPE_NOKIA_SITE:
1769 return 1;
1770 default:
1771 break;
1772 }
1773
1774 return 0;
1775}
1776
Sylvain Munaut57a1ec52020-05-08 09:58:26 +02001777static inline int is_ericsson_bts(struct gsm_bts *bts)
1778{
1779 switch (bts->type) {
1780 case GSM_BTS_TYPE_RBS2000:
1781 return 1;
1782 default:
1783 break;
1784 }
1785
1786 return 0;
1787}
1788
Andreas Eversbergdcf38e12013-12-05 14:37:11 +01001789static inline int is_e1_bts(struct gsm_bts *bts)
1790{
1791 switch (bts->type) {
1792 case GSM_BTS_TYPE_BS11:
1793 case GSM_BTS_TYPE_RBS2000:
1794 case GSM_BTS_TYPE_NOKIA_SITE:
1795 return 1;
1796 default:
1797 break;
1798 }
1799
1800 return 0;
1801}
1802
Harald Welte1876c312018-05-27 11:53:43 +02001803extern struct gsm_network *bsc_gsmnet;
1804
Holger Hans Peter Freyther4e13a8f2015-01-31 22:16:00 +01001805enum bts_gprs_mode bts_gprs_mode_parse(const char *arg, int *valid);
Harald Welte4511d892010-04-18 15:51:20 +02001806const char *bts_gprs_mode_name(enum bts_gprs_mode mode);
Holger Hans Peter Freyther4e13a8f2015-01-31 22:16:00 +01001807int bts_gprs_mode_is_compat(struct gsm_bts *bts, enum bts_gprs_mode mode);
Harald Welte4511d892010-04-18 15:51:20 +02001808
Neels Hofmeyr4d358c02018-02-22 03:19:05 +01001809void gsm48_ra_id_by_bts(struct gsm48_ra_id *buf, struct gsm_bts *bts);
Harald Welte97a282b2010-03-14 15:37:43 +08001810void gprs_ra_id_by_bts(struct gprs_ra_id *raid, struct gsm_bts *bts);
Harald Welted12b0fd2009-12-15 21:36:05 +01001811
Harald Weltefbda4e12010-03-04 11:04:52 +01001812int gsm_bts_model_register(struct gsm_bts_model *model);
1813
Harald Welte3561bd42018-01-28 03:04:16 +01001814struct gsm_subscriber_connection *bsc_subscr_con_allocate(struct gsm_network *network);
Neels Hofmeyr42eb0142016-05-20 17:15:44 +02001815
Neels Hofmeyr958f2592018-05-27 01:26:31 +02001816struct gsm_bts *gsm_bts_alloc_register(struct gsm_network *net, enum gsm_bts_type type, uint8_t bsic);
1817struct 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 +01001818
Harald Welte3300c012011-06-05 13:31:33 +02001819void set_ts_e1link(struct gsm_bts_trx_ts *ts, uint8_t e1_nr,
1820 uint8_t e1_ts, uint8_t e1_ts_ss);
1821
Maxbe356ed2017-09-07 19:10:09 +02001822void gsm_trx_lock_rf(struct gsm_bts_trx *trx, bool locked, const char *reason);
Harald Welte3300c012011-06-05 13:31:33 +02001823struct gsm_bts_trx *gsm_bts_trx_by_nr(struct gsm_bts *bts, int nr);
Holger Hans Peter Freythera49b2c02014-11-21 11:18:45 +01001824int gsm_bts_trx_set_system_infos(struct gsm_bts_trx *trx);
Alexander Chemerisc36a13b2015-05-30 14:40:54 -04001825int gsm_bts_set_system_infos(struct gsm_bts *bts);
Harald Welte3300c012011-06-05 13:31:33 +02001826
Pablo Neira Ayusoed5cacb2011-08-17 22:44:07 +02001827/* generic E1 line operations for all ISDN-based BTS. */
1828extern struct e1inp_line_ops bts_isdn_e1inp_line_ops;
1829
Harald Weltee555c2b2012-08-17 13:02:12 +02001830extern const struct value_string bts_type_names[_NUM_GSM_BTS_TYPE+1];
1831extern const struct value_string bts_type_descs[_NUM_GSM_BTS_TYPE+1];
1832
Max3d049d22017-10-09 17:12:53 +02001833char *get_model_oml_status(const struct gsm_bts *bts);
1834
Max25cc4072017-10-10 14:50:35 +02001835unsigned long long bts_uptime(const struct gsm_bts *bts);
1836
Holger Hans Peter Freytherf8c42192013-01-09 17:03:27 +01001837/* control interface handling */
1838int bsc_base_ctrl_cmds_install(void);
1839
Holger Hans Peter Freytherc22930e2014-12-17 14:46:17 +01001840/* dependency handling */
1841void bts_depend_mark(struct gsm_bts *bts, int dep);
1842void bts_depend_clear(struct gsm_bts *bts, int dep);
1843int bts_depend_check(struct gsm_bts *bts);
Holger Hans Peter Freytherf7e23c52014-12-17 15:44:32 +01001844int bts_depend_is_depedency(struct gsm_bts *base, struct gsm_bts *other);
Holger Hans Peter Freytherc22930e2014-12-17 14:46:17 +01001845
Harald Welte2f8b9d22017-06-18 11:12:13 +03001846int gsm_bts_get_radio_link_timeout(const struct gsm_bts *bts);
1847void gsm_bts_set_radio_link_timeout(struct gsm_bts *bts, int value);
1848
Neels Hofmeyr958f2592018-05-27 01:26:31 +02001849bool trx_is_usable(const struct gsm_bts_trx *trx);
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001850bool ts_is_usable(const struct gsm_bts_trx_ts *ts);
Neels Hofmeyr958f2592018-05-27 01:26:31 +02001851
Neels Hofmeyr31f525e2018-05-14 18:14:15 +02001852int gsm_lchan_type_by_pchan(enum gsm_phys_chan_config pchan);
1853enum gsm_phys_chan_config gsm_pchan_by_lchan_type(enum gsm_chan_t type);
1854
1855void gsm_bts_all_ts_dispatch(struct gsm_bts *bts, uint32_t ts_ev, void *data);
1856void gsm_trx_all_ts_dispatch(struct gsm_bts_trx *trx, uint32_t ts_ev, void *data);
1857
1858int bts_count_free_ts(struct gsm_bts *bts, enum gsm_phys_chan_config pchan);
Neels Hofmeyr958f2592018-05-27 01:26:31 +02001859
Vadim Yanitskiy73bd4632019-11-02 00:57:23 +07001860bool trx_has_valid_pchan_config(const struct gsm_bts_trx *trx);
1861
Harald Welte6be350c2011-05-25 13:10:08 +02001862#endif /* _GSM_DATA_H */