blob: a8bcd5d6a47c1c212bdfe00db7cd91033cf82df5 [file] [log] [blame]
Harald Welte6be350c2011-05-25 13:10:08 +02001#ifndef _GSM_DATA_SHAREDH
2#define _GSM_DATA_SHAREDH
3
Holger Hans Peter Freyther06c9da62011-06-09 21:48:49 +02004#include <regex.h>
Harald Welte6be350c2011-05-25 13:10:08 +02005#include <stdbool.h>
6#include <stdint.h>
7
8#include <osmocom/core/timer.h>
9#include <osmocom/core/bitvec.h>
10#include <osmocom/core/statistics.h>
11#include <osmocom/core/utils.h>
12#include <osmocom/gsm/gsm_utils.h>
13#include <osmocom/gsm/tlv.h>
14#include <osmocom/gsm/rxlev_stat.h>
15#include <osmocom/gsm/sysinfo.h>
Harald Welte7ff4f0e2013-03-07 18:38:09 +000016#include <osmocom/gsm/meas_rep.h>
Maxc08ee712016-05-11 12:45:13 +020017#include <osmocom/gsm/protocol/gsm_04_08.h>
Harald Welte6be350c2011-05-25 13:10:08 +020018#include <osmocom/gsm/protocol/gsm_08_58.h>
Harald Welte3300c012011-06-05 13:31:33 +020019#include <osmocom/gsm/protocol/gsm_12_21.h>
Harald Welte6be350c2011-05-25 13:10:08 +020020
Harald Welte0eae6132011-08-24 13:52:07 +020021#include <osmocom/abis/e1_input.h>
22
Holger Hans Peter Freyther0e0a09c2012-12-20 19:03:18 +010023#ifndef ROLE_BSC
24#include <osmocom/gsm/lapdm.h>
25#endif
26
Holger Hans Peter Freyther8ec49522011-08-15 15:53:00 +020027struct osmo_bsc_data;
28
Harald Welte6be350c2011-05-25 13:10:08 +020029struct osmo_bsc_sccp_con;
30struct gsm_sms_queue;
31
32/* RRLP mode of operation */
33enum rrlp_mode {
34 RRLP_MODE_NONE,
35 RRLP_MODE_MS_BASED,
36 RRLP_MODE_MS_PREF,
37 RRLP_MODE_ASS_PREF,
38};
39
40/* Channel Request reason */
41enum gsm_chreq_reason_t {
42 GSM_CHREQ_REASON_EMERG,
43 GSM_CHREQ_REASON_PAG,
44 GSM_CHREQ_REASON_CALL,
45 GSM_CHREQ_REASON_LOCATION_UPD,
46 GSM_CHREQ_REASON_OTHER,
47};
48
49#define TRX_NR_TS 8
50#define TS_MAX_LCHAN 8
51
52#define HARDCODED_ARFCN 123
Harald Welte6be350c2011-05-25 13:10:08 +020053#define HARDCODED_BSIC 0x3f /* NCC = 7 / BCC = 7 */
54
55/* for multi-drop config */
56#define HARDCODED_BTS0_TS 1
57#define HARDCODED_BTS1_TS 6
58#define HARDCODED_BTS2_TS 11
59
Harald Welte6be350c2011-05-25 13:10:08 +020060enum gsm_hooks {
61 GSM_HOOK_NM_SWLOAD,
62 GSM_HOOK_RR_PAGING,
63 GSM_HOOK_RR_SECURITY,
64};
65
66enum gsm_paging_event {
67 GSM_PAGING_SUCCEEDED,
68 GSM_PAGING_EXPIRED,
69 GSM_PAGING_OOM,
70 GSM_PAGING_BUSY,
71};
72
73enum bts_gprs_mode {
74 BTS_GPRS_NONE = 0,
75 BTS_GPRS_GPRS = 1,
76 BTS_GPRS_EGPRS = 2,
77};
78
79struct gsm_lchan;
80struct gsm_subscriber;
81struct gsm_mncc;
Harald Welte135a6bd2011-09-04 13:53:26 +020082struct osmo_rtp_socket;
Harald Welte6be350c2011-05-25 13:10:08 +020083struct rtp_socket;
84struct bsc_api;
85
86/* Network Management State */
87struct gsm_nm_state {
88 uint8_t operational;
89 uint8_t administrative;
90 uint8_t availability;
91};
92
Harald Welted64c0bc2011-05-30 12:07:53 +020093struct gsm_abis_mo {
Harald Welte3300c012011-06-05 13:31:33 +020094 uint8_t obj_class;
Holger Hans Peter Freyther49976f42013-11-05 16:06:17 +010095 uint8_t procedure_pending;
Harald Welte3300c012011-06-05 13:31:33 +020096 struct abis_om_obj_inst obj_inst;
Harald Welted64c0bc2011-05-30 12:07:53 +020097 const char *name;
98 struct gsm_nm_state nm_state;
99 struct tlv_parsed *nm_attr;
Harald Welte32bc1162011-06-06 18:58:48 +0200100 struct gsm_bts *bts;
Harald Welted64c0bc2011-05-30 12:07:53 +0200101};
102
Harald Welte6be350c2011-05-25 13:10:08 +0200103#define MAX_A5_KEY_LEN (128/8)
104#define A38_XOR_MIN_KEY_LEN 12
105#define A38_XOR_MAX_KEY_LEN 16
106#define A38_COMP128_KEY_LEN 16
107#define RSL_ENC_ALG_A5(x) (x+1)
Max27c3e762016-04-20 15:57:12 +0200108#define MAX_EARFCN_LIST 32
Harald Welte6be350c2011-05-25 13:10:08 +0200109
110/* is the data link established? who established it? */
111#define LCHAN_SAPI_UNUSED 0
112#define LCHAN_SAPI_MS 1
113#define LCHAN_SAPI_NET 2
Andreas Eversberg7d8fa342013-12-05 13:25:06 +0100114#define LCHAN_SAPI_REL 3
Harald Welte6be350c2011-05-25 13:10:08 +0200115
116/* state of a logical channel */
117enum gsm_lchan_state {
118 LCHAN_S_NONE, /* channel is not active */
Holger Hans Peter Freytherded02682012-01-15 00:02:17 +0100119 LCHAN_S_ACT_REQ, /* channel activation requested */
Harald Welte6be350c2011-05-25 13:10:08 +0200120 LCHAN_S_ACTIVE, /* channel is active and operational */
121 LCHAN_S_REL_REQ, /* channel release has been requested */
122 LCHAN_S_REL_ERR, /* channel is in an error state */
Holger Hans Peter Freyther638da512012-12-06 19:25:06 +0100123 LCHAN_S_BROKEN, /* channel is somehow unusable */
Harald Welte6be350c2011-05-25 13:10:08 +0200124 LCHAN_S_INACTIVE, /* channel is set inactive */
125};
126
Harald Weltec7921c92011-06-29 10:38:34 +0200127/* BTS ONLY */
128#define MAX_NUM_UL_MEAS 104
129#define LC_UL_M_F_L1_VALID (1 << 0)
130#define LC_UL_M_F_RES_VALID (1 << 1)
131
132struct bts_ul_meas {
133 /* BER in units of 0.01%: 10.000 == 100% ber, 0 == 0% ber */
134 uint16_t ber10k;
135 /* timing advance offset (in quarter bits) */
136 int16_t ta_offs_qbits;
137 /* C/I ratio in dB */
138 float c_i;
139 /* flags */
140 uint8_t is_sub:1;
141 /* RSSI in dBm * -1 */
142 uint8_t inv_rssi;
143};
Harald Weltef3b59322011-09-06 22:14:43 +0200144
Andreas Eversberga83d5112013-12-07 18:32:28 +0100145struct bts_codec_conf {
146 uint8_t hr;
147 uint8_t efr;
148 uint8_t amr;
149};
150
Harald Weltef3b59322011-09-06 22:14:43 +0200151struct amr_mode {
152 uint8_t mode;
Holger Hans Peter Freyther615ed462015-09-24 11:30:58 +0200153 uint8_t threshold;
154 uint8_t hysteresis;
Harald Weltef3b59322011-09-06 22:14:43 +0200155};
Holger Hans Peter Freyther615ed462015-09-24 11:30:58 +0200156
Harald Weltef3b59322011-09-06 22:14:43 +0200157struct amr_multirate_conf {
158 uint8_t gsm48_ie[2];
Holger Hans Peter Freyther615ed462015-09-24 11:30:58 +0200159 struct amr_mode ms_mode[4];
160 struct amr_mode bts_mode[4];
Harald Weltef3b59322011-09-06 22:14:43 +0200161 uint8_t num_modes;
162};
Harald Weltec7921c92011-06-29 10:38:34 +0200163/* /BTS ONLY */
164
Harald Weltee4227982012-08-24 15:33:56 +0200165enum lchan_csd_mode {
166 LCHAN_CSD_M_NT,
167 LCHAN_CSD_M_T_1200_75,
168 LCHAN_CSD_M_T_600,
169 LCHAN_CSD_M_T_1200,
170 LCHAN_CSD_M_T_2400,
171 LCHAN_CSD_M_T_9600,
172 LCHAN_CSD_M_T_14400,
173 LCHAN_CSD_M_T_29000,
174 LCHAN_CSD_M_T_32000,
175};
176
Daniel Willmann324c8052012-12-29 12:32:30 +0100177/* State of the SAPIs in the lchan */
178enum lchan_sapi_state {
179 LCHAN_SAPI_S_NONE,
180 LCHAN_SAPI_S_REQ,
181 LCHAN_SAPI_S_ASSIGNED,
182 LCHAN_SAPI_S_REL,
183 LCHAN_SAPI_S_ERROR,
184};
185
Harald Welte6be350c2011-05-25 13:10:08 +0200186struct gsm_lchan {
187 /* The TS that we're part of */
188 struct gsm_bts_trx_ts *ts;
189 /* The logical subslot number in the TS */
190 uint8_t nr;
191 /* The logical channel type */
192 enum gsm_chan_t type;
193 /* RSL channel mode */
194 enum rsl_cmod_spd rsl_cmode;
195 /* If TCH, traffic channel mode */
196 enum gsm48_chan_mode tch_mode;
Harald Weltee4227982012-08-24 15:33:56 +0200197 enum lchan_csd_mode csd_mode;
Harald Welte6be350c2011-05-25 13:10:08 +0200198 /* State */
199 enum gsm_lchan_state state;
Holger Hans Peter Freyther454140e2014-12-28 12:08:28 +0100200 const char *broken_reason;
Harald Welte6be350c2011-05-25 13:10:08 +0200201 /* Power levels for MS and BTS */
202 uint8_t bs_power;
203 uint8_t ms_power;
204 /* Encryption information */
205 struct {
206 uint8_t alg_id;
207 uint8_t key_len;
208 uint8_t key[MAX_A5_KEY_LEN];
209 } encr;
210
211 /* AMR bits */
Andreas Eversberg73266522014-01-19 11:47:44 +0100212 uint8_t mr_ms_lv[7];
213 uint8_t mr_bts_lv[7];
Harald Welte6be350c2011-05-25 13:10:08 +0200214
215 /* Established data link layer services */
216 uint8_t sapis[8];
Holger Hans Peter Freytherb9b828b2013-01-01 19:20:28 +0100217 int sacch_deact;
Holger Hans Peter Freytherdfcfe652011-12-27 20:49:53 +0100218
Harald Welte6be350c2011-05-25 13:10:08 +0200219 struct {
220 uint32_t bound_ip;
221 uint32_t connect_ip;
222 uint16_t bound_port;
223 uint16_t connect_port;
224 uint16_t conn_id;
225 uint8_t rtp_payload;
226 uint8_t rtp_payload2;
227 uint8_t speech_mode;
Harald Welte135a6bd2011-09-04 13:53:26 +0200228#ifdef ROLE_BSC
Harald Welte6be350c2011-05-25 13:10:08 +0200229 struct rtp_socket *rtp_socket;
Harald Welte135a6bd2011-09-04 13:53:26 +0200230#else
231 struct osmo_rtp_socket *rtp_socket;
232#endif
Harald Welte6be350c2011-05-25 13:10:08 +0200233 } abis_ip;
234
Harald Welte2c1ae472011-06-26 14:13:37 +0200235 uint8_t rqd_ta;
236
Harald Weltec696cc22015-12-05 16:19:21 +0100237 char *name;
238
Harald Welte6be350c2011-05-25 13:10:08 +0200239#ifdef ROLE_BSC
240 struct osmo_timer_list T3101;
Holger Hans Peter Freytherb3489392011-12-28 16:21:05 +0100241 struct osmo_timer_list T3109;
Harald Welte6be350c2011-05-25 13:10:08 +0200242 struct osmo_timer_list T3111;
243 struct osmo_timer_list error_timer;
Harald Weltee8bd9e82011-08-10 23:26:33 +0200244 struct osmo_timer_list act_timer;
Andreas Eversberg7d8fa342013-12-05 13:25:06 +0100245 struct osmo_timer_list rel_work;
Holger Hans Peter Freyther638da512012-12-06 19:25:06 +0100246 uint8_t error_cause;
Harald Welte6be350c2011-05-25 13:10:08 +0200247
248 /* table of neighbor cell measurements */
249 struct neigh_meas_proc neigh_meas[MAX_NEIGH_MEAS];
250
251 /* cache of last measurement reports on this lchan */
252 struct gsm_meas_rep meas_rep[6];
253 int meas_rep_idx;
254
255 /* GSM Random Access data */
256 struct gsm48_req_ref *rqd_ref;
Harald Welte6be350c2011-05-25 13:10:08 +0200257
258 struct gsm_subscriber_connection *conn;
Harald Weltef6093a42011-06-25 10:02:33 +0200259#else
Daniel Willmann324c8052012-12-29 12:32:30 +0100260 /* Number of different GsmL1_Sapi_t used in osmo_bts_sysmo is 23.
261 * Currently we don't share these headers so this is a magic number. */
Holger Hans Peter Freyther30156e12013-04-05 18:41:45 +0200262 struct llist_head sapi_cmds;
Daniel Willmann324c8052012-12-29 12:32:30 +0100263 uint8_t sapis_dl[23];
264 uint8_t sapis_ul[23];
Harald Weltef6093a42011-06-25 10:02:33 +0200265 struct lapdm_channel lapdm_ch;
Harald Welte135a6bd2011-09-04 13:53:26 +0200266 struct llist_head dl_tch_queue;
Harald Welte2c1ae472011-06-26 14:13:37 +0200267 struct {
268 /* bitmask of all SI that are present/valid in si_buf */
269 uint32_t valid;
270 uint32_t last;
271 /* buffers where we put the pre-computed SI */
272 sysinfo_buf_t buf[_MAX_SYSINFO_TYPE];
273 } si;
Harald Weltec7921c92011-06-29 10:38:34 +0200274 struct {
275 uint8_t flags;
276 /* RSL measurment result number, 0 at lchan_act */
277 uint8_t res_nr;
278 /* current Tx power level of the BTS */
279 uint8_t bts_tx_pwr;
280 /* number of measurements stored in array below */
281 uint8_t num_ul_meas;
282 struct bts_ul_meas uplink[MAX_NUM_UL_MEAS];
283 /* last L1 header from the MS */
284 uint8_t l1_info[2];
Harald Welte7ff4f0e2013-03-07 18:38:09 +0000285 struct gsm_meas_rep_unidir ul_res;
Harald Weltec7921c92011-06-29 10:38:34 +0200286 } meas;
Harald Weltef3b59322011-09-06 22:14:43 +0200287 struct {
288 struct amr_multirate_conf amr_mr;
Harald Welte43290992011-09-07 12:41:38 +0200289 struct {
290 uint8_t buf[16];
291 uint8_t len;
Maxf5fe31d2016-06-10 14:09:07 +0200292 uint32_t fn;
293 bool is_update;
Harald Welte43290992011-09-07 12:41:38 +0200294 } last_sid;
Maxf5fe31d2016-06-10 14:09:07 +0200295 /* set for each SID frame to detect talkspurt for codecs without
296 explicit ONSET event */
297 bool ul_sid;
Holger Hans Peter Freyther922ef5d2014-07-24 21:05:32 +0200298 uint8_t last_cmr;
Maxd7df7ae2016-06-03 12:06:26 +0200299 uint32_t last_fn;
Maxae3f0712016-06-09 12:29:50 +0200300 /* indicates if DTXd was active during DL measurement period */
301 bool dtxd_active;
Harald Weltef3b59322011-09-06 22:14:43 +0200302 } tch;
Harald Welte5d52c972012-04-08 20:23:28 +0200303 /* BTS-side ciphering state (rx only, bi-directional, ...) */
304 uint8_t ciph_state;
Holger Hans Peter Freyther2c6b59c2014-08-09 09:43:53 +0200305 uint8_t ciph_ns;
Harald Welte46cb8512012-04-19 23:13:35 +0200306 uint8_t loopback;
Harald Welte704cb862012-06-16 14:57:08 +0800307 struct {
308 uint8_t active;
309 uint8_t ref;
310 /* T3105: PHYS INF retransmission */
311 struct osmo_timer_list t3105;
312 /* counts up to Ny1 */
313 unsigned int phys_info_count;
314 } ho;
Andreas Eversberg1af682a2013-02-20 16:06:20 +0100315 /* S counter for link loss */
316 int s;
Holger Hans Peter Freytherfc7a75f2013-10-25 18:58:30 +0200317 /* Kind of the release/activation. E.g. RSL or PCU */
318 int rel_act_kind;
Holger Hans Peter Freytherf6f86b02015-02-05 22:25:03 +0100319
320 /* power handling */
321 struct {
322 uint8_t current;
323 uint8_t fixed;
324 } ms_power_ctrl;
Harald Welte6be350c2011-05-25 13:10:08 +0200325#endif
326};
327
Harald Welte6be350c2011-05-25 13:10:08 +0200328#define TS_F_PDCH_MODE 0x1000
329/* One Timeslot in a TRX */
330struct gsm_bts_trx_ts {
331 struct gsm_bts_trx *trx;
332 /* number of this timeslot at the TRX */
333 uint8_t nr;
334
335 enum gsm_phys_chan_config pchan;
336
337 unsigned int flags;
Harald Welted64c0bc2011-05-30 12:07:53 +0200338 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200339 struct tlv_parsed nm_attr;
340 uint8_t nm_chan_comb;
Harald Welte135a6482011-05-30 12:09:13 +0200341 int tsc; /* -1 == use BTS TSC */
Harald Welte6be350c2011-05-25 13:10:08 +0200342
343 struct {
344 /* Parameters below are configured by VTY */
345 int enabled;
346 uint8_t maio;
347 uint8_t hsn;
348 struct bitvec arfcns;
349 uint8_t arfcns_data[1024/8];
350 /* This is the pre-computed MA for channel assignments */
351 struct bitvec ma;
352 uint8_t ma_len; /* part of ma_data that is used */
353 uint8_t ma_data[8]; /* 10.5.2.21: max 8 bytes value part */
354 } hopping;
355
356 /* To which E1 subslot are we connected */
357 struct gsm_e1_subslot e1_link;
358
359 struct gsm_lchan lchan[TS_MAX_LCHAN];
360};
361
362/* One TRX in a BTS */
363struct gsm_bts_trx {
364 /* list header in bts->trx_list */
365 struct llist_head list;
366
367 struct gsm_bts *bts;
368 /* number of this TRX in the BTS */
369 uint8_t nr;
370 /* human readable name / description */
371 char *description;
372 /* how do we talk RSL with this TRX? */
373 struct gsm_e1_subslot rsl_e1_link;
374 uint8_t rsl_tei;
375 struct e1inp_sign_link *rsl_link;
Holger Hans Peter Freythercaa98d52013-10-06 15:52:14 +0200376
Harald Welte6be350c2011-05-25 13:10:08 +0200377 /* Some BTS (specifically Ericsson RBS) have a per-TRX OML Link */
378 struct e1inp_sign_link *oml_link;
379
Harald Welted64c0bc2011-05-30 12:07:53 +0200380 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200381 struct tlv_parsed nm_attr;
382 struct {
Harald Welted64c0bc2011-05-30 12:07:53 +0200383 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200384 } bb_transc;
385
386 uint16_t arfcn;
387 int nominal_power; /* in dBm */
388 unsigned int max_power_red; /* in actual dB */
Holger Hans Peter Freyther9b625802014-07-30 18:20:51 +0200389
390#ifndef ROLE_BSC
Harald Welte101c5c22014-08-22 16:12:03 +0200391 struct trx_power_params power_params;
Holger Hans Peter Freytherf6f86b02015-02-05 22:25:03 +0100392 int ms_power_control;
Harald Welte6be350c2011-05-25 13:10:08 +0200393
Harald Welted134cc72011-06-07 00:12:53 +0200394 struct {
395 void *l1h;
396 } role_bts;
Holger Hans Peter Freyther9b625802014-07-30 18:20:51 +0200397#endif
Harald Welted134cc72011-06-07 00:12:53 +0200398
Harald Welte6be350c2011-05-25 13:10:08 +0200399 union {
400 struct {
401 struct {
Harald Welted64c0bc2011-05-30 12:07:53 +0200402 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200403 } bbsig;
404 struct {
Harald Welted64c0bc2011-05-30 12:07:53 +0200405 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200406 } pa;
407 } bs11;
408 struct {
409 unsigned int test_state;
410 uint8_t test_nr;
411 struct rxlev_stats rxlev_stat;
412 } ipaccess;
413 };
414 struct gsm_bts_trx_ts ts[TRX_NR_TS];
415};
416
417#define GSM_BTS_SI(bts, i) (void *)(bts->si_buf[i])
418
419enum gsm_bts_type {
420 GSM_BTS_TYPE_UNKNOWN,
421 GSM_BTS_TYPE_BS11,
422 GSM_BTS_TYPE_NANOBTS,
423 GSM_BTS_TYPE_RBS2000,
Dieter Spaar16646022011-07-28 00:01:50 +0200424 GSM_BTS_TYPE_NOKIA_SITE,
Harald Weltef383aa12012-07-02 19:51:55 +0200425 GSM_BTS_TYPE_OSMO_SYSMO,
Harald Weltee555c2b2012-08-17 13:02:12 +0200426 _NUM_GSM_BTS_TYPE
Harald Welte6be350c2011-05-25 13:10:08 +0200427};
428
429struct vty;
430
431struct gsm_bts_model {
432 struct llist_head list;
433
434 enum gsm_bts_type type;
435 const char *name;
436
437 bool started;
438 int (*start)(struct gsm_network *net);
439 int (*oml_rcvmsg)(struct msgb *msg);
440
Pablo Neira Ayusoed5cacb2011-08-17 22:44:07 +0200441 void (*e1line_bind_ops)(struct e1inp_line *line);
442
Harald Welte6be350c2011-05-25 13:10:08 +0200443 void (*config_write_bts)(struct vty *vty, struct gsm_bts *bts);
444 void (*config_write_trx)(struct vty *vty, struct gsm_bts_trx *trx);
445 void (*config_write_ts)(struct vty *vty, struct gsm_bts_trx_ts *ts);
446
447 struct tlv_definition nm_att_tlvdef;
448
449 struct bitvec features;
450 uint8_t _features_data[128/8];
451};
452
453enum gsm_bts_features {
454 BTS_FEAT_HSCSD,
455 BTS_FEAT_GPRS,
456 BTS_FEAT_EGPRS,
457 BTS_FEAT_ECSD,
458 BTS_FEAT_HOPPING,
Harald Welte903aaea2014-01-19 17:10:50 +0100459 BTS_FEAT_MULTI_TSC,
Harald Welte6be350c2011-05-25 13:10:08 +0200460};
461
462/*
463 * This keeps track of the paging status of one BTS. It
464 * includes a number of pending requests, a back pointer
465 * to the gsm_bts, a timer and some more state.
466 */
467struct gsm_bts_paging_state {
468 /* pending requests */
469 struct llist_head pending_requests;
470 struct gsm_bts *bts;
471
472 struct osmo_timer_list work_timer;
473 struct osmo_timer_list credit_timer;
474
475 /* free chans needed */
476 int free_chans_need;
477
478 /* load */
479 uint16_t available_slots;
480};
481
482struct gsm_envabtse {
Harald Welted64c0bc2011-05-30 12:07:53 +0200483 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200484};
485
486struct gsm_bts_gprs_nsvc {
487 struct gsm_bts *bts;
488 /* data read via VTY config file, to configure the BTS
489 * via OML from BSC */
490 int id;
491 uint16_t nsvci;
492 uint16_t local_port; /* on the BTS */
493 uint16_t remote_port; /* on the SGSN */
494 uint32_t remote_ip; /* on the SGSN */
495
Harald Welted64c0bc2011-05-30 12:07:53 +0200496 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200497};
498
Harald Welte019f9132012-06-28 08:43:14 +0200499enum gprs_rlc_par {
500 RLC_T3142,
501 RLC_T3169,
502 RLC_T3191,
503 RLC_T3193,
504 RLC_T3195,
505 RLC_N3101,
506 RLC_N3103,
507 RLC_N3105,
508 CV_COUNTDOWN,
509 T_DL_TBF_EXT, /* ms */
510 T_UL_TBF_EXT, /* ms */
511 _NUM_RLC_PAR
512};
513
514enum gprs_cs {
515 GPRS_CS1,
516 GPRS_CS2,
517 GPRS_CS3,
518 GPRS_CS4,
519 GPRS_MCS1,
520 GPRS_MCS2,
521 GPRS_MCS3,
522 GPRS_MCS4,
523 GPRS_MCS5,
524 GPRS_MCS6,
525 GPRS_MCS7,
526 GPRS_MCS8,
527 GPRS_MCS9,
528 _NUM_GRPS_CS
529};
530
531struct gprs_rlc_cfg {
532 uint16_t parameter[_NUM_RLC_PAR];
533 struct {
534 uint16_t repeat_time; /* ms */
535 uint8_t repeat_count;
536 } paging;
537 uint32_t cs_mask; /* bitmask of gprs_cs */
538 uint8_t initial_cs;
539 uint8_t initial_mcs;
540};
541
542
Harald Welte6be350c2011-05-25 13:10:08 +0200543enum neigh_list_manual_mode {
544 NL_MODE_AUTOMATIC = 0,
545 NL_MODE_MANUAL = 1,
546 NL_MODE_MANUAL_SI5SEP = 2, /* SI2 and SI5 have separate neighbor lists */
547};
548
Daniel Willmann47b5b3e2011-08-05 13:51:27 +0200549enum bts_loc_fix {
550 BTS_LOC_FIX_INVALID = 0,
551 BTS_LOC_FIX_2D = 1,
552 BTS_LOC_FIX_3D = 2,
553};
554
Daniel Willmann7d109832012-05-14 18:43:23 +0200555extern const struct value_string bts_loc_fix_names[];
556
Daniel Willmann47b5b3e2011-08-05 13:51:27 +0200557struct bts_location {
558 struct llist_head list;
559 time_t tstamp;
560 enum bts_loc_fix valid;
561 double lat;
562 double lon;
563 double height;
564};
565
Harald Welte6be350c2011-05-25 13:10:08 +0200566/* One BTS */
567struct gsm_bts {
568 /* list header in net->bts_list */
569 struct llist_head list;
570
Daniel Willmann47b5b3e2011-08-05 13:51:27 +0200571 /* Geographical location of the BTS */
572 struct llist_head loc_list;
573
Harald Welte6be350c2011-05-25 13:10:08 +0200574 /* number of ths BTS in network */
575 uint8_t nr;
576 /* human readable name / description */
577 char *description;
578 /* Cell Identity */
579 uint16_t cell_identity;
580 /* location area code of this BTS */
581 uint16_t location_area_code;
Harald Weltea2bbc5e2015-11-20 10:43:31 +0100582 /* Base Station Identification Code (BSIC), lower 3 bits is BCC,
583 * which is used as TSC for the CCCH */
Harald Welte6be350c2011-05-25 13:10:08 +0200584 uint8_t bsic;
585 /* type of BTS */
586 enum gsm_bts_type type;
587 struct gsm_bts_model *model;
588 enum gsm_band band;
589 /* maximum Tx power that the MS is permitted to use in this cell */
590 int ms_max_power;
591
592 /* how do we talk OML with this TRX? */
593 struct gsm_e1_subslot oml_e1_link;
594 uint8_t oml_tei;
595 struct e1inp_sign_link *oml_link;
596
597 /* Abis network management O&M handle */
598 struct abis_nm_h *nmh;
Harald Welted64c0bc2011-05-30 12:07:53 +0200599
600 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200601
602 /* number of this BTS on given E1 link */
603 uint8_t bts_nr;
604
Maxc08ee712016-05-11 12:45:13 +0200605 /* DTX features of this BTS */
606 enum gsm48_dtx_mode dtxu;
607 bool dtxd;
608
Harald Welte6be350c2011-05-25 13:10:08 +0200609 /* paging state and control */
610 struct gsm_bts_paging_state paging;
611
612 /* CCCH is on C0 */
613 struct gsm_bts_trx *c0;
614
615 struct {
Harald Welted64c0bc2011-05-30 12:07:53 +0200616 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200617 } site_mgr;
618
619 /* bitmask of all SI that are present/valid in si_buf */
620 uint32_t si_valid;
621 /* buffers where we put the pre-computed SI */
622 sysinfo_buf_t si_buf[_MAX_SYSINFO_TYPE];
623
Gus Bourg1c5dd2c2011-12-02 10:18:17 +0100624 /* TimeZone hours, mins, and bts specific */
Harald Welte45f91712012-07-08 16:48:11 +0200625 struct {
626 int hr;
627 int mn;
628 int override;
Jacob Erlbeck946d1412013-09-17 13:59:29 +0200629 int dst;
Harald Welte45f91712012-07-08 16:48:11 +0200630 } tz;
Gus Bourg1c5dd2c2011-12-02 10:18:17 +0100631
Harald Welte6be350c2011-05-25 13:10:08 +0200632 /* ip.accesss Unit ID's have Site/BTS/TRX layout */
633 union {
634 struct {
635 uint16_t site_id;
636 uint16_t bts_id;
637 uint32_t flags;
Harald Welte8b291802013-03-12 13:57:05 +0100638 uint32_t rsl_ip;
Harald Welte6be350c2011-05-25 13:10:08 +0200639 } ip_access;
640 struct {
641 struct {
Harald Welted64c0bc2011-05-30 12:07:53 +0200642 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200643 } cclk;
644 struct {
Harald Welted64c0bc2011-05-30 12:07:53 +0200645 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200646 } rack;
647 struct gsm_envabtse envabtse[4];
648 } bs11;
649 struct {
650 struct {
Harald Welted64c0bc2011-05-30 12:07:53 +0200651 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200652 struct llist_head conn_groups;
653 } is;
654 struct {
Harald Welted64c0bc2011-05-30 12:07:53 +0200655 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200656 struct llist_head conn_groups;
657 } con;
658 struct {
Harald Welted64c0bc2011-05-30 12:07:53 +0200659 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200660 } dp;
661 struct {
Harald Welted64c0bc2011-05-30 12:07:53 +0200662 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200663 } tf;
664 } rbs2000;
665 struct {
Harald Weltec8755af2011-07-28 00:22:17 +0200666 uint8_t bts_type;
Holger Hans Peter Freyther3e603482012-03-02 14:14:33 +0100667 unsigned int configured:1,
668 skip_reset:1,
Andreas Eversberg7d8fa342013-12-05 13:25:06 +0100669 no_loc_rel_cnf:1,
Sipos Csaba56e17662015-02-07 13:27:36 +0100670 bts_reset_timer_cnf,
Holger Hans Peter Freyther3e603482012-03-02 14:14:33 +0100671 did_reset:1,
672 wait_reset:1;
Harald Weltec8755af2011-07-28 00:22:17 +0200673 struct osmo_timer_list reset_timer;
674 } nokia;
Harald Welte6be350c2011-05-25 13:10:08 +0200675 };
676
677 /* Not entirely sure how ip.access specific this is */
678 struct {
679 enum bts_gprs_mode mode;
680 struct {
Harald Welted64c0bc2011-05-30 12:07:53 +0200681 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200682 uint16_t nsei;
683 uint8_t timer[7];
684 } nse;
685 struct {
Harald Welted64c0bc2011-05-30 12:07:53 +0200686 struct gsm_abis_mo mo;
Harald Welte6be350c2011-05-25 13:10:08 +0200687 uint16_t bvci;
688 uint8_t timer[11];
Harald Welte019f9132012-06-28 08:43:14 +0200689 struct gprs_rlc_cfg rlc_cfg;
Harald Welte6be350c2011-05-25 13:10:08 +0200690 } cell;
691 struct gsm_bts_gprs_nsvc nsvc[2];
692 uint8_t rac;
Andreas Eversberg0c8f9ca2013-03-16 16:31:26 +0100693 uint8_t net_ctrl_ord;
Harald Welte6be350c2011-05-25 13:10:08 +0200694 } gprs;
695
696 /* RACH NM values */
697 int rach_b_thresh;
698 int rach_ldavg_slots;
699
700 /* transceivers */
701 int num_trx;
702 struct llist_head trx_list;
703
Holger Hans Peter Freytherb92a5382014-11-21 10:00:39 +0100704 /* SI related items */
Jacob Erlbeck65d114f2014-01-16 11:02:14 +0100705 int force_combined_si;
Holger Hans Peter Freytherb92a5382014-11-21 10:00:39 +0100706 int bcch_change_mark;
Jacob Erlbeck65d114f2014-01-16 11:02:14 +0100707
Harald Welte6be350c2011-05-25 13:10:08 +0200708#ifdef ROLE_BSC
709 /* Abis NM queue */
710 struct llist_head abis_queue;
711 int abis_nm_pend;
712
713 struct gsm_network *network;
714
715 /* should the channel allocator allocate channels from high TRX to TRX0,
716 * rather than starting from TRX0 and go upwards? */
717 int chan_alloc_reverse;
718
719 enum neigh_list_manual_mode neigh_list_manual_mode;
720 /* parameters from which we build SYSTEM INFORMATION */
721 struct {
722 struct gsm48_rach_control rach_control;
723 uint8_t ncc_permitted;
724 struct gsm48_cell_sel_par cell_sel_par;
725 struct gsm48_si_selection_params cell_ro_sel_par; /* rest octet */
726 struct gsm48_cell_options cell_options;
727 struct gsm48_control_channel_descr chan_desc;
728 struct bitvec neigh_list;
729 struct bitvec cell_alloc;
730 struct bitvec si5_neigh_list;
Max59a1bf32016-04-15 16:04:46 +0200731 struct osmo_earfcn_si2q si2quater_neigh_list;
Max26679e02016-04-20 15:57:13 +0200732 size_t uarfcn_length; /* index for uarfcn and scramble lists */
Harald Welte6be350c2011-05-25 13:10:08 +0200733 struct {
734 /* bitmask large enough for all possible ARFCN's */
735 uint8_t neigh_list[1024/8];
736 uint8_t cell_alloc[1024/8];
737 /* If the user wants a different neighbor list in SI5 than in SI2 */
738 uint8_t si5_neigh_list[1024/8];
Max59a1bf32016-04-15 16:04:46 +0200739 uint8_t meas_bw_list[MAX_EARFCN_LIST];
740 uint16_t earfcn_list[MAX_EARFCN_LIST];
Max26679e02016-04-20 15:57:13 +0200741 uint16_t uarfcn_list[MAX_EARFCN_LIST];
742 uint16_t scramble_list[MAX_EARFCN_LIST];
Harald Welte6be350c2011-05-25 13:10:08 +0200743 } data;
744 } si_common;
745
746 /* do we use static (user-defined) system information messages? (bitmask) */
747 uint32_t si_mode_static;
Holger Hans Peter Freythere30d40d2012-07-20 10:27:31 +0200748
749 /* exclude the BTS from the global RF Lock handling */
750 int excl_from_rf_lock;
Andreas Eversberga83d5112013-12-07 18:32:28 +0100751
752 /* supported codecs beside FR */
753 struct bts_codec_conf codec;
Holger Hans Peter Freytherc22930e2014-12-17 14:46:17 +0100754
755 /* BTS dependencies bit field */
756 uint32_t depends_on[256/(8*4)];
Andreas Eversberg73266522014-01-19 11:47:44 +0100757
758 /* full and half rate multirate config */
759 struct amr_multirate_conf mr_full;
760 struct amr_multirate_conf mr_half;
761
Harald Welte6be350c2011-05-25 13:10:08 +0200762#endif /* ROLE_BSC */
Harald Welte978714d2011-06-06 18:31:20 +0200763 void *role;
Harald Welte6be350c2011-05-25 13:10:08 +0200764};
765
766
Harald Welte3300c012011-06-05 13:31:33 +0200767struct gsm_bts *gsm_bts_alloc(void *talloc_ctx);
Harald Welte1449c9f2014-08-24 09:50:10 +0200768struct gsm_bts *gsm_bts_num(struct gsm_network *net, int num);
Harald Welte6be350c2011-05-25 13:10:08 +0200769
Harald Welte1449c9f2014-08-24 09:50:10 +0200770struct gsm_bts_trx *gsm_bts_trx_alloc(struct gsm_bts *bts);
Harald Welte4f8ad532011-09-19 14:21:51 +0200771struct gsm_bts_trx *gsm_bts_trx_num(const struct gsm_bts *bts, int num);
Harald Welte6be350c2011-05-25 13:10:08 +0200772
Harald Welte4ab9d7c2012-08-17 12:42:06 +0200773
Harald Welte30f1f372014-12-28 15:00:45 +0100774const struct value_string gsm_pchant_names[12];
775const struct value_string gsm_pchant_descs[12];
776const struct value_string gsm_lchant_names[8];
Harald Welte6be350c2011-05-25 13:10:08 +0200777const char *gsm_pchan_name(enum gsm_phys_chan_config c);
778enum gsm_phys_chan_config gsm_pchan_parse(const char *name);
779const char *gsm_lchant_name(enum gsm_chan_t c);
780const char *gsm_chreq_name(enum gsm_chreq_reason_t c);
Harald Welte4f8ad532011-09-19 14:21:51 +0200781char *gsm_trx_name(const struct gsm_bts_trx *trx);
782char *gsm_ts_name(const struct gsm_bts_trx_ts *ts);
Harald Weltec696cc22015-12-05 16:19:21 +0100783char *gsm_lchan_name_compute(const struct gsm_lchan *lchan);
Harald Welte6be350c2011-05-25 13:10:08 +0200784const char *gsm_lchans_name(enum gsm_lchan_state s);
785
Harald Weltec696cc22015-12-05 16:19:21 +0100786static inline char *gsm_lchan_name(const struct gsm_lchan *lchan)
787{
788 return lchan->name;
789}
Harald Welte6be350c2011-05-25 13:10:08 +0200790
Harald Welteb7849982011-06-29 16:49:03 +0200791void gsm_abis_mo_reset(struct gsm_abis_mo *mo);
792
Harald Welte978714d2011-06-06 18:31:20 +0200793struct gsm_abis_mo *
794gsm_objclass2mo(struct gsm_bts *bts, uint8_t obj_class,
Harald Welte4f8ad532011-09-19 14:21:51 +0200795 const struct abis_om_obj_inst *obj_inst);
Harald Welte978714d2011-06-06 18:31:20 +0200796
797struct gsm_nm_state *
798gsm_objclass2nmstate(struct gsm_bts *bts, uint8_t obj_class,
Harald Welte4f8ad532011-09-19 14:21:51 +0200799 const struct abis_om_obj_inst *obj_inst);
Harald Welte978714d2011-06-06 18:31:20 +0200800void *
801gsm_objclass2obj(struct gsm_bts *bts, uint8_t obj_class,
Harald Welte4f8ad532011-09-19 14:21:51 +0200802 const struct abis_om_obj_inst *obj_inst);
Harald Welte978714d2011-06-06 18:31:20 +0200803
Harald Welteb7849982011-06-29 16:49:03 +0200804/* reset the state of all MO in the BTS */
805void gsm_bts_mo_reset(struct gsm_bts *bts);
806
Harald Weltef6093a42011-06-25 10:02:33 +0200807uint8_t gsm_ts2chan_nr(const struct gsm_bts_trx_ts *ts, uint8_t lchan_nr);
808uint8_t gsm_lchan2chan_nr(const struct gsm_lchan *lchan);
809
Harald Welte142d12d2014-12-29 17:47:08 +0100810/* return the gsm_lchan for the CBCH (if it exists at all) */
811struct gsm_lchan *gsm_bts_get_cbch(struct gsm_bts *bts);
812
Holger Hans Peter Freyther06c9da62011-06-09 21:48:49 +0200813/*
814 * help with parsing regexps
815 */
816int gsm_parse_reg(void *ctx, regex_t *reg, char **str,
817 int argc, const char **argv) __attribute__ ((warn_unused_result));
818
Harald Welte1fe24122014-01-19 17:18:21 +0100819static inline uint8_t gsm_ts_tsc(const struct gsm_bts_trx_ts *ts)
820{
821 if (ts->tsc != -1)
822 return ts->tsc;
823 else
Harald Weltea2bbc5e2015-11-20 10:43:31 +0100824 return ts->trx->bts->bsic & 7;
Harald Welte1fe24122014-01-19 17:18:21 +0100825}
Holger Hans Peter Freyther06c9da62011-06-09 21:48:49 +0200826
827
Harald Welte6be350c2011-05-25 13:10:08 +0200828#endif