blob: 97827f2d958cb8247d2dafc5a643f3fc283a20d3 [file] [log] [blame]
Harald Weltea43f7892009-12-01 18:04:30 +05301/* GSM 04.08 System Information (SI) encoding and decoding
2 * 3GPP TS 04.08 version 7.21.0 Release 1998 / ETSI TS 100 940 V7.21.0 */
3
Harald Welte7401ae62010-06-15 16:44:12 +02004/* (C) 2008-2010 by Harald Welte <laforge@gnumonks.org>
Holger Hans Peter Freyther511f9c32012-10-13 12:38:54 +02005 * (C) 2012 Holger Hans Peter Freyther
Harald Weltea43f7892009-12-01 18:04:30 +05306 *
7 * All Rights Reserved
8 *
9 * This program is free software; you can redistribute it and/or modify
Harald Welte9af6ddf2011-01-01 15:25:50 +010010 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
Harald Weltea43f7892009-12-01 18:04:30 +053012 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Harald Welte9af6ddf2011-01-01 15:25:50 +010017 * GNU Affero General Public License for more details.
Harald Weltea43f7892009-12-01 18:04:30 +053018 *
Harald Welte9af6ddf2011-01-01 15:25:50 +010019 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
Harald Weltea43f7892009-12-01 18:04:30 +053021 *
22 */
23
24#include <errno.h>
25#include <string.h>
Harald Welte6c40def2009-12-14 22:07:14 +010026#include <stdio.h>
Harald Weltea43f7892009-12-01 18:04:30 +053027#include <netinet/in.h>
28
Harald Welte80cffaf2011-05-24 15:02:20 +020029#include <osmocom/core/bitvec.h>
30#include <osmocom/core/utils.h>
31#include <osmocom/gsm/sysinfo.h>
32
33#include <openbsc/debug.h>
Harald Weltea43f7892009-12-01 18:04:30 +053034#include <openbsc/gsm_04_08.h>
35#include <openbsc/gsm_data.h>
36#include <openbsc/abis_rsl.h>
37#include <openbsc/rest_octets.h>
Holger Hans Peter Freyther511f9c32012-10-13 12:38:54 +020038#include <openbsc/arfcn_range_encode.h>
Harald Weltea43f7892009-12-01 18:04:30 +053039
Holger Hans Peter Freytherd4d1d5e2013-01-17 13:49:39 +010040/*
41 * DCS1800 and PCS1900 have overlapping ARFCNs. We would need to set the
42 * ARFCN_PCS flag on the 1900 ARFCNs but this would increase cell_alloc
43 * and other arrays to make sure (ARFCN_PCS + 1024)/8 ARFCNs fit into the
44 * array. DCS1800 and PCS1900 can not be used at the same time so conserve
45 * memory and do the below.
46 */
47static int band_compatible(const struct gsm_bts *bts, int arfcn)
48{
49 enum gsm_band band = gsm_arfcn2band(arfcn);
50
51 /* normal case */
52 if (band == bts->band)
53 return 1;
54 /* deal with ARFCN_PCS not set */
55 if (band == GSM_BAND_1800 && bts->band == GSM_BAND_1900)
56 return 1;
57
58 return 0;
59}
Holger Hans Peter Freytherb91a1062010-01-06 06:38:14 +010060
Holger Hans Peter Freytherf876c392013-03-06 12:02:33 +010061static int is_dcs_net(const struct gsm_bts *bts)
62{
63 if (bts->band == GSM_BAND_850)
64 return 0;
65 if (bts->band == GSM_BAND_1900)
66 return 0;
67 return 1;
68}
69
Holger Hans Peter Freyther9e1952a2013-01-17 12:04:17 +010070static int use_arfcn(const struct gsm_bts *bts, const int bis, const int ter,
71 const int pgsm, const int arfcn)
72{
Jacob Erlbeck65d114f2014-01-16 11:02:14 +010073 if (bts->force_combined_si)
74 return !bis && !ter;
Holger Hans Peter Freytherd4d1d5e2013-01-17 13:49:39 +010075 if (!bis && !ter && band_compatible(bts, arfcn))
Holger Hans Peter Freyther9e1952a2013-01-17 12:04:17 +010076 return 1;
Jacob Erlbeck65d114f2014-01-16 11:02:14 +010077 /* Correct but somehow broken with either the nanoBTS or the iPhone5 */
Holger Hans Peter Freytherd4d1d5e2013-01-17 13:49:39 +010078 if (bis && pgsm && band_compatible(bts, arfcn) && (arfcn < 1 || arfcn > 124))
Holger Hans Peter Freyther9e1952a2013-01-17 12:04:17 +010079 return 1;
Holger Hans Peter Freytherd4d1d5e2013-01-17 13:49:39 +010080 if (ter && !band_compatible(bts, arfcn))
Holger Hans Peter Freyther9e1952a2013-01-17 12:04:17 +010081 return 1;
82 return 0;
83}
84
Harald Welteda760d32009-12-14 20:25:05 +010085/* Frequency Lists as per TS 04.08 10.5.2.13 */
86
87/* 10.5.2.13.2: Bit map 0 format */
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +020088static int freq_list_bm0_set_arfcn(uint8_t *chan_list, unsigned int arfcn)
Harald Weltea43f7892009-12-01 18:04:30 +053089{
90 unsigned int byte, bit;
91
Harald Welteb1d4c8e2009-12-17 23:10:46 +010092 if (arfcn > 124 || arfcn < 1) {
93 LOGP(DRR, LOGL_ERROR, "Bitmap 0 only supports ARFCN 1...124\n");
Harald Weltea43f7892009-12-01 18:04:30 +053094 return -EINVAL;
Harald Welteb1d4c8e2009-12-17 23:10:46 +010095 }
Harald Weltea43f7892009-12-01 18:04:30 +053096
Harald Welteda760d32009-12-14 20:25:05 +010097 /* the bitmask is from 1..124, not from 0..123 */
98 arfcn--;
99
Harald Weltea43f7892009-12-01 18:04:30 +0530100 byte = arfcn / 8;
101 bit = arfcn % 8;
102
Harald Welteda760d32009-12-14 20:25:05 +0100103 chan_list[GSM48_CELL_CHAN_DESC_SIZE-1-byte] |= (1 << bit);
Harald Weltea43f7892009-12-01 18:04:30 +0530104
105 return 0;
106}
107
Harald Welteda760d32009-12-14 20:25:05 +0100108/* 10.5.2.13.7: Variable bit map format */
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200109static int freq_list_bmrel_set_arfcn(uint8_t *chan_list, unsigned int arfcn)
Harald Weltea43f7892009-12-01 18:04:30 +0530110{
111 unsigned int byte, bit;
112 unsigned int min_arfcn;
113 unsigned int bitno;
114
115 min_arfcn = (chan_list[0] & 1) << 9;
116 min_arfcn |= chan_list[1] << 1;
117 min_arfcn |= (chan_list[2] >> 7) & 1;
118
119 /* The lower end of our bitmaks is always implicitly included */
120 if (arfcn == min_arfcn)
121 return 0;
122
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100123 if (((arfcn - min_arfcn) & 1023) > 111) {
Harald Welteb1d4c8e2009-12-17 23:10:46 +0100124 LOGP(DRR, LOGL_ERROR, "arfcn(%u) > min(%u) + 111\n", arfcn, min_arfcn);
Harald Weltea43f7892009-12-01 18:04:30 +0530125 return -EINVAL;
Harald Welte152b6262009-12-16 11:57:48 +0100126 }
Harald Weltea43f7892009-12-01 18:04:30 +0530127
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100128 bitno = (arfcn - min_arfcn) & 1023;
Harald Weltea43f7892009-12-01 18:04:30 +0530129 byte = bitno / 8;
130 bit = bitno % 8;
131
132 chan_list[2 + byte] |= 1 << (7 - bit);
133
134 return 0;
135}
136
Holger Hans Peter Freyther511f9c32012-10-13 12:38:54 +0200137/* generate a variable bitmap */
138static int enc_freq_lst_var_bitmap(uint8_t *chan_list,
139 struct bitvec *bv, const struct gsm_bts *bts,
140 int bis, int ter, int min, int pgsm)
141{
142 int i;
143
144 /* set it to 'Variable bitmap format' */
145 chan_list[0] = 0x8e;
146
147 chan_list[0] |= (min >> 9) & 1;
148 chan_list[1] = (min >> 1);
149 chan_list[2] = (min & 1) << 7;
150
151 for (i = 0; i < bv->data_len*8; i++) {
152 /* see notes in bitvec2freq_list */
153 if (bitvec_get_bit_pos(bv, i)
154 && ((!bis && !ter && gsm_arfcn2band(i) == bts->band)
155 || (bis && pgsm && gsm_arfcn2band(i) == bts->band && (i < 1 || i > 124))
156 || (ter && gsm_arfcn2band(i) != bts->band))) {
157 int rc = freq_list_bmrel_set_arfcn(chan_list, i);
158 if (rc < 0)
159 return rc;
160 }
161 }
162
163 return 0;
164}
165
166/* generate a frequency list with the range 512 format */
167static int enc_freq_lst_range(uint8_t *chan_list,
168 struct bitvec *bv, const struct gsm_bts *bts,
169 int bis, int ter, int pgsm)
170{
171 int arfcns[RANGE_ENC_MAX_ARFCNS];
172 int w[RANGE_ENC_MAX_ARFCNS];
173 int f0_included = 0;
174 int arfcns_used = 0;
175 int i, rc, range, f0;
176
177 /*
178 * Select ARFCNs according to the rules in bitvec2freq_list
179 */
180 for (i = 0; i < bv->data_len * 8; ++i) {
181 /* More ARFCNs than the maximum */
182 if (arfcns_used > ARRAY_SIZE(arfcns))
183 return -1;
184 /* Check if we can select it? */
Holger Hans Peter Freyther9e1952a2013-01-17 12:04:17 +0100185 if (bitvec_get_bit_pos(bv, i) && use_arfcn(bts, bis, ter, pgsm, i))
Holger Hans Peter Freyther511f9c32012-10-13 12:38:54 +0200186 arfcns[arfcns_used++] = i;
Holger Hans Peter Freyther511f9c32012-10-13 12:38:54 +0200187 }
188
189 /*
190 * Check if the given list of ARFCNs can be encoded.
191 */
192 range = range_enc_determine_range(arfcns, arfcns_used, &f0);
193 if (range == ARFCN_RANGE_INVALID)
194 return -2;
195
196 /*
197 * Manipulate the ARFCN list according to the rules in J4 depending
198 * on the selected range.
199 */
Jacob Erlbeck45014a02014-01-14 10:42:58 +0100200 arfcns_used = range_enc_filter_arfcns(arfcns, arfcns_used,
Holger Hans Peter Freyther511f9c32012-10-13 12:38:54 +0200201 f0, &f0_included);
202
203 memset(w, 0, sizeof(w));
204 rc = range_enc_arfcns(range, arfcns, arfcns_used, w, 0);
205 if (rc != 0)
206 return -3;
207
208 /* Select the range and the amount of bits needed */
209 switch (range) {
210 case ARFCN_RANGE_128:
211 return range_enc_range128(chan_list, f0, w);
212 break;
213 case ARFCN_RANGE_256:
214 return range_enc_range256(chan_list, f0, w);
215 break;
216 case ARFCN_RANGE_512:
217 return range_enc_range512(chan_list, f0, w);
218 break;
219 case ARFCN_RANGE_1024:
220 return range_enc_range1024(chan_list, f0, f0_included, w);
221 break;
222 default:
223 return -4;
224 };
225}
226
Harald Weltea43f7892009-12-01 18:04:30 +0530227/* generate a cell channel list as per Section 10.5.2.1b of 04.08 */
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200228static int bitvec2freq_list(uint8_t *chan_list, struct bitvec *bv,
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100229 const struct gsm_bts *bts, int bis, int ter)
Harald Weltea43f7892009-12-01 18:04:30 +0530230{
Holger Hans Peter Freyther511f9c32012-10-13 12:38:54 +0200231 int i, rc, min = -1, max = -1, pgsm = 0, arfcns = 0;
Harald Weltea43f7892009-12-01 18:04:30 +0530232
233 memset(chan_list, 0, 16);
234
Harald Welte29350342012-02-17 15:58:23 +0100235 if (bts->band == GSM_BAND_900
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100236 && bts->c0->arfcn >= 1 && bts->c0->arfcn <= 124)
237 pgsm = 1;
238 /* P-GSM-only handsets only support 'bit map 0 format' */
239 if (!bis && !ter && pgsm) {
Harald Weltea43f7892009-12-01 18:04:30 +0530240 chan_list[0] = 0;
Harald Welte6c40def2009-12-14 22:07:14 +0100241
242 for (i = 0; i < bv->data_len*8; i++) {
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100243 if (i >= 1 && i <= 124
244 && bitvec_get_bit_pos(bv, i)) {
Harald Welte6c40def2009-12-14 22:07:14 +0100245 rc = freq_list_bm0_set_arfcn(chan_list, i);
246 if (rc < 0)
247 return rc;
248 }
Harald Weltea43f7892009-12-01 18:04:30 +0530249 }
250 return 0;
251 }
252
Harald Welte6c40def2009-12-14 22:07:14 +0100253 for (i = 0; i < bv->data_len*8; i++) {
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100254 /* in case of SI2 or SI5 allow all neighbours in same band
255 * in case of SI*bis, allow neighbours in same band ouside pgsm
256 * in case of SI*ter, allow neighbours in different bands
257 */
Holger Hans Peter Freyther9e1952a2013-01-17 12:04:17 +0100258 if (!bitvec_get_bit_pos(bv, i))
259 continue;
260 if (!use_arfcn(bts, bis, ter, pgsm, i))
261 continue;
262 /* count the arfcns we want to carry */
263 arfcns += 1;
Holger Hans Peter Freyther511f9c32012-10-13 12:38:54 +0200264
Holger Hans Peter Freyther9e1952a2013-01-17 12:04:17 +0100265 /* 955..1023 < 0..885 */
266 if (min < 0)
267 min = i;
268 if (i >= 955 && min < 955)
269 min = i;
270 if (i >= 955 && min >= 955 && i < min)
271 min = i;
272 if (i < 955 && min < 955 && i < min)
273 min = i;
274 if (max < 0)
275 max = i;
276 if (i < 955 && max >= 955)
277 max = i;
278 if (i >= 955 && max >= 955 && i > max)
279 max = i;
280 if (i < 955 && max < 955 && i > max)
281 max = i;
Harald Weltea43f7892009-12-01 18:04:30 +0530282 }
283
Sylvain Munaut42a56522009-12-24 14:20:19 +0100284 if (max == -1) {
285 /* Empty set, use 'bit map 0 format' */
286 chan_list[0] = 0;
287 return 0;
288 }
289
Holger Hans Peter Freyther511f9c32012-10-13 12:38:54 +0200290 /* Now find the best encoding */
291 if (((max - min) & 1023) <= 111)
292 return enc_freq_lst_var_bitmap(chan_list, bv, bts, bis,
293 ter, min, pgsm);
Harald Weltea43f7892009-12-01 18:04:30 +0530294
Holger Hans Peter Freyther511f9c32012-10-13 12:38:54 +0200295 /* Attempt to do the range encoding */
296 rc = enc_freq_lst_range(chan_list, bv, bts, bis, ter, pgsm);
297 if (rc == 0)
298 return 0;
Harald Weltea43f7892009-12-01 18:04:30 +0530299
Holger Hans Peter Freyther511f9c32012-10-13 12:38:54 +0200300 LOGP(DRR, LOGL_ERROR, "min_arfcn=%u, max_arfcn=%u, arfcns=%d "
301 "can not generate ARFCN list", min, max, arfcns);
302 return -EINVAL;
Harald Weltea43f7892009-12-01 18:04:30 +0530303}
304
305/* generate a cell channel list as per Section 10.5.2.1b of 04.08 */
Dieter Spaar16646022011-07-28 00:01:50 +0200306/* static*/ int generate_cell_chan_list(uint8_t *chan_list, struct gsm_bts *bts)
Harald Weltea43f7892009-12-01 18:04:30 +0530307{
Harald Weltea43f7892009-12-01 18:04:30 +0530308 struct gsm_bts_trx *trx;
Harald Welte6c40def2009-12-14 22:07:14 +0100309 struct bitvec *bv = &bts->si_common.cell_alloc;
Harald Weltea43f7892009-12-01 18:04:30 +0530310
Harald Weltea39b0f22010-06-14 22:26:10 +0200311 /* Zero-initialize the bit-vector */
Harald Weltec8794b52010-06-16 11:09:18 +0200312 memset(bv->data, 0, bv->data_len);
Harald Weltea39b0f22010-06-14 22:26:10 +0200313
Harald Welte6c40def2009-12-14 22:07:14 +0100314 /* first we generate a bitvec of all TRX ARFCN's in our BTS */
Harald Weltea39b0f22010-06-14 22:26:10 +0200315 llist_for_each_entry(trx, &bts->trx_list, list) {
316 unsigned int i, j;
317 /* Always add the TRX's ARFCN */
Harald Welte6c40def2009-12-14 22:07:14 +0100318 bitvec_set_bit_pos(bv, trx->arfcn, 1);
Harald Weltea39b0f22010-06-14 22:26:10 +0200319 for (i = 0; i < ARRAY_SIZE(trx->ts); i++) {
320 struct gsm_bts_trx_ts *ts = &trx->ts[i];
321 /* Add any ARFCNs present in hopping channels */
322 for (j = 0; j < 1024; j++) {
323 if (bitvec_get_bit_pos(&ts->hopping.arfcns, j))
324 bitvec_set_bit_pos(bv, j, 1);
325 }
326 }
327 }
Harald Weltea43f7892009-12-01 18:04:30 +0530328
Harald Welte6c40def2009-12-14 22:07:14 +0100329 /* then we generate a GSM 04.08 frequency list from the bitvec */
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100330 return bitvec2freq_list(chan_list, bv, bts, 0, 0);
Harald Weltea43f7892009-12-01 18:04:30 +0530331}
332
Harald Welte6c40def2009-12-14 22:07:14 +0100333/* generate a cell channel list as per Section 10.5.2.1b of 04.08 */
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100334static int generate_bcch_chan_list(uint8_t *chan_list, struct gsm_bts *bts,
335 int si5, int bis, int ter)
Harald Welte6c40def2009-12-14 22:07:14 +0100336{
337 struct gsm_bts *cur_bts;
Harald Welte64c07d22011-02-15 11:43:27 +0100338 struct bitvec *bv;
339
340 if (si5 && bts->neigh_list_manual_mode == NL_MODE_MANUAL_SI5SEP)
341 bv = &bts->si_common.si5_neigh_list;
342 else
343 bv = &bts->si_common.neigh_list;
Harald Welte6c40def2009-12-14 22:07:14 +0100344
Harald Welte32c09622011-01-11 23:44:56 +0100345 /* Generate list of neighbor cells if we are in automatic mode */
Harald Welte64c07d22011-02-15 11:43:27 +0100346 if (bts->neigh_list_manual_mode == NL_MODE_AUTOMATIC) {
Harald Welte21bbda22011-02-19 20:43:37 +0100347 /* Zero-initialize the bit-vector */
348 memset(bv->data, 0, bv->data_len);
349
Harald Welte32c09622011-01-11 23:44:56 +0100350 /* first we generate a bitvec of the BCCH ARFCN's in our BSC */
351 llist_for_each_entry(cur_bts, &bts->network->bts_list, list) {
352 if (cur_bts == bts)
353 continue;
354 bitvec_set_bit_pos(bv, cur_bts->c0->arfcn, 1);
355 }
Harald Welte6c40def2009-12-14 22:07:14 +0100356 }
357
358 /* then we generate a GSM 04.08 frequency list from the bitvec */
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100359 return bitvec2freq_list(chan_list, bv, bts, bis, ter);
360}
361
362static int list_arfcn(uint8_t *chan_list, uint8_t mask, char *text)
363{
364 int n = 0, i;
365 struct gsm_sysinfo_freq freq[1024];
366
367 memset(freq, 0, sizeof(freq));
368 gsm48_decode_freq_list(freq, chan_list, 16, 0xce, 1);
369 for (i = 0; i < 1024; i++) {
370 if (freq[i].mask) {
371 if (!n)
372 LOGP(DRR, LOGL_INFO, "%s", text);
373 LOGPC(DRR, LOGL_INFO, " %d", i);
374 n++;
375 }
376 }
377 if (n)
378 LOGPC(DRR, LOGL_INFO, "\n");
379
380 return n;
Harald Welte6c40def2009-12-14 22:07:14 +0100381}
382
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200383static int generate_si1(uint8_t *output, struct gsm_bts *bts)
Harald Weltea43f7892009-12-01 18:04:30 +0530384{
385 int rc;
386 struct gsm48_system_information_type_1 *si1 =
387 (struct gsm48_system_information_type_1 *) output;
388
389 memset(si1, GSM_MACBLOCK_PADDING, GSM_MACBLOCK_LEN);
390
391 si1->header.l2_plen = (21 << 2) | 1;
392 si1->header.rr_protocol_discriminator = GSM48_PDISC_RR;
393 si1->header.skip_indicator = 0;
394 si1->header.system_information = GSM48_MT_RR_SYSINFO_1;
395
396 rc = generate_cell_chan_list(si1->cell_channel_description, bts);
397 if (rc < 0)
398 return rc;
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100399 list_arfcn(si1->cell_channel_description, 0xce, "Serving cell:");
Harald Weltea43f7892009-12-01 18:04:30 +0530400
401 si1->rach_control = bts->si_common.rach_control;
402
Holger Hans Peter Freytherf876c392013-03-06 12:02:33 +0100403 /*
404 * SI1 Rest Octets (10.5.2.32), contains NCH position and band
405 * indicator but that is not in the 04.08.
406 */
407 rc = rest_octets_si1(si1->rest_octets, NULL, is_dcs_net(bts));
Harald Welte7401ae62010-06-15 16:44:12 +0200408
Holger Hans Peter Freyther7ec448d2010-01-06 07:52:31 +0100409 return sizeof(*si1) + rc;
Harald Weltea43f7892009-12-01 18:04:30 +0530410}
411
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200412static int generate_si2(uint8_t *output, struct gsm_bts *bts)
Harald Weltea43f7892009-12-01 18:04:30 +0530413{
414 int rc;
415 struct gsm48_system_information_type_2 *si2 =
416 (struct gsm48_system_information_type_2 *) output;
417
418 memset(si2, GSM_MACBLOCK_PADDING, GSM_MACBLOCK_LEN);
419
420 si2->header.l2_plen = (22 << 2) | 1;
421 si2->header.rr_protocol_discriminator = GSM48_PDISC_RR;
422 si2->header.skip_indicator = 0;
423 si2->header.system_information = GSM48_MT_RR_SYSINFO_2;
424
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100425 rc = generate_bcch_chan_list(si2->bcch_frequency_list, bts, 0, 0, 0);
Harald Weltea43f7892009-12-01 18:04:30 +0530426 if (rc < 0)
427 return rc;
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100428 list_arfcn(si2->bcch_frequency_list, 0xce,
429 "Neighbour cells in same band:");
Harald Weltea43f7892009-12-01 18:04:30 +0530430
431 si2->ncc_permitted = bts->si_common.ncc_permitted;
432 si2->rach_control = bts->si_common.rach_control;
433
Holger Hans Peter Freyther7ec448d2010-01-06 07:52:31 +0100434 return sizeof(*si2);
Harald Weltea43f7892009-12-01 18:04:30 +0530435}
436
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100437static int generate_si2bis(uint8_t *output, struct gsm_bts *bts)
438{
439 int rc;
440 struct gsm48_system_information_type_2bis *si2b =
441 (struct gsm48_system_information_type_2bis *) output;
442 int n;
443
444 memset(si2b, GSM_MACBLOCK_PADDING, GSM_MACBLOCK_LEN);
445
446 si2b->header.l2_plen = (22 << 2) | 1;
447 si2b->header.rr_protocol_discriminator = GSM48_PDISC_RR;
448 si2b->header.skip_indicator = 0;
449 si2b->header.system_information = GSM48_MT_RR_SYSINFO_2bis;
450
451 rc = generate_bcch_chan_list(si2b->bcch_frequency_list, bts, 0, 1, 0);
452 if (rc < 0)
453 return rc;
454 n = list_arfcn(si2b->bcch_frequency_list, 0xce,
455 "Neighbour cells in same band, but outside P-GSM:");
456 if (n) {
457 /* indicate in SI2 and SI2bis: there is an extension */
458 struct gsm48_system_information_type_2 *si2 =
459 (struct gsm48_system_information_type_2 *)
460 bts->si_buf[SYSINFO_TYPE_2];
461 si2->bcch_frequency_list[0] |= 0x20;
462 si2b->bcch_frequency_list[0] |= 0x20;
463 } else
464 bts->si_valid &= ~(1 << SYSINFO_TYPE_2bis);
465
466 si2b->rach_control = bts->si_common.rach_control;
467
468 return sizeof(*si2b);
469}
470
471static int generate_si2ter(uint8_t *output, struct gsm_bts *bts)
472{
473 int rc;
474 struct gsm48_system_information_type_2ter *si2t =
475 (struct gsm48_system_information_type_2ter *) output;
476 int n;
477
478 memset(si2t, GSM_MACBLOCK_PADDING, GSM_MACBLOCK_LEN);
479
480 si2t->header.l2_plen = (22 << 2) | 1;
481 si2t->header.rr_protocol_discriminator = GSM48_PDISC_RR;
482 si2t->header.skip_indicator = 0;
483 si2t->header.system_information = GSM48_MT_RR_SYSINFO_2ter;
484
485 rc = generate_bcch_chan_list(si2t->ext_bcch_frequency_list, bts, 0, 0, 1);
486 if (rc < 0)
487 return rc;
488 n = list_arfcn(si2t->ext_bcch_frequency_list, 0x8e,
489 "Neighbour cells in different band:");
490 if (!n)
491 bts->si_valid &= ~(1 << SYSINFO_TYPE_2ter);
492
493 return sizeof(*si2t);
494}
495
Harald Welte1f893292010-03-14 23:46:48 +0800496static struct gsm48_si_ro_info si_info = {
Harald Weltea43f7892009-12-01 18:04:30 +0530497 .selection_params = {
498 .present = 0,
499 },
500 .power_offset = {
501 .present = 0,
502 },
503 .si2ter_indicator = 0,
504 .early_cm_ctrl = 1,
505 .scheduling = {
506 .present = 0,
507 },
508 .gprs_ind = {
509 .si13_position = 0,
510 .ra_colour = 0,
Harald Welte97a282b2010-03-14 15:37:43 +0800511 .present = 1,
Harald Weltea43f7892009-12-01 18:04:30 +0530512 },
513 .lsa_params = {
514 .present = 0,
515 },
516 .cell_id = 0, /* FIXME: doesn't the bts have this? */
517 .break_ind = 0,
518};
519
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200520static int generate_si3(uint8_t *output, struct gsm_bts *bts)
Harald Weltea43f7892009-12-01 18:04:30 +0530521{
Holger Hans Peter Freyther7ec448d2010-01-06 07:52:31 +0100522 int rc;
Harald Weltea43f7892009-12-01 18:04:30 +0530523 struct gsm48_system_information_type_3 *si3 =
524 (struct gsm48_system_information_type_3 *) output;
525
526 memset(si3, GSM_MACBLOCK_PADDING, GSM_MACBLOCK_LEN);
527
528 si3->header.l2_plen = (18 << 2) | 1;
529 si3->header.rr_protocol_discriminator = GSM48_PDISC_RR;
530 si3->header.skip_indicator = 0;
531 si3->header.system_information = GSM48_MT_RR_SYSINFO_3;
532
533 si3->cell_identity = htons(bts->cell_identity);
Harald Welteafedeab2010-03-04 10:55:40 +0100534 gsm48_generate_lai(&si3->lai, bts->network->country_code,
535 bts->network->network_code,
536 bts->location_area_code);
Harald Weltea43f7892009-12-01 18:04:30 +0530537 si3->control_channel_desc = bts->si_common.chan_desc;
538 si3->cell_options = bts->si_common.cell_options;
539 si3->cell_sel_par = bts->si_common.cell_sel_par;
540 si3->rach_control = bts->si_common.rach_control;
541
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100542 if ((bts->si_valid & (1 << SYSINFO_TYPE_2ter))) {
543 LOGP(DRR, LOGL_INFO, "SI 2ter is included.\n");
544 si_info.si2ter_indicator = 1;
545 } else {
546 si_info.si2ter_indicator = 0;
547 }
548
Harald Weltea43f7892009-12-01 18:04:30 +0530549 /* SI3 Rest Octets (10.5.2.34), containing
550 CBQ, CELL_RESELECT_OFFSET, TEMPORARY_OFFSET, PENALTY_TIME
551 Power Offset, 2ter Indicator, Early Classmark Sending,
552 Scheduling if and WHERE, GPRS Indicator, SI13 position */
Holger Hans Peter Freyther7ec448d2010-01-06 07:52:31 +0100553 rc = rest_octets_si3(si3->rest_octets, &si_info);
Harald Weltea43f7892009-12-01 18:04:30 +0530554
Holger Hans Peter Freyther7ec448d2010-01-06 07:52:31 +0100555 return sizeof(*si3) + rc;
Harald Weltea43f7892009-12-01 18:04:30 +0530556}
557
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200558static int generate_si4(uint8_t *output, struct gsm_bts *bts)
Harald Weltea43f7892009-12-01 18:04:30 +0530559{
Holger Hans Peter Freyther7ec448d2010-01-06 07:52:31 +0100560 int rc;
Harald Weltea43f7892009-12-01 18:04:30 +0530561 struct gsm48_system_information_type_4 *si4 =
562 (struct gsm48_system_information_type_4 *) output;
563
564 /* length of all IEs present except SI4 rest octets and l2_plen */
565 int l2_plen = sizeof(*si4) - 1;
566
567 memset(si4, GSM_MACBLOCK_PADDING, GSM_MACBLOCK_LEN);
568
569 si4->header.rr_protocol_discriminator = GSM48_PDISC_RR;
570 si4->header.skip_indicator = 0;
571 si4->header.system_information = GSM48_MT_RR_SYSINFO_4;
572
Harald Welteafedeab2010-03-04 10:55:40 +0100573 gsm48_generate_lai(&si4->lai, bts->network->country_code,
574 bts->network->network_code,
575 bts->location_area_code);
Harald Weltea43f7892009-12-01 18:04:30 +0530576 si4->cell_sel_par = bts->si_common.cell_sel_par;
577 si4->rach_control = bts->si_common.rach_control;
578
579 /* Optional: CBCH Channel Description + CBCH Mobile Allocation */
580
581 si4->header.l2_plen = (l2_plen << 2) | 1;
582
583 /* SI4 Rest Octets (10.5.2.35), containing
584 Optional Power offset, GPRS Indicator,
585 Cell Identity, LSA ID, Selection Parameter */
Holger Hans Peter Freyther7ec448d2010-01-06 07:52:31 +0100586 rc = rest_octets_si4(si4->data, &si_info);
Harald Weltea43f7892009-12-01 18:04:30 +0530587
Holger Hans Peter Freyther7ec448d2010-01-06 07:52:31 +0100588 return sizeof(*si4) + rc;
Harald Weltea43f7892009-12-01 18:04:30 +0530589}
590
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200591static int generate_si5(uint8_t *output, struct gsm_bts *bts)
Harald Weltea43f7892009-12-01 18:04:30 +0530592{
Harald Weltee2d0d5f2009-12-19 21:26:54 +0100593 struct gsm48_system_information_type_5 *si5;
594 int rc, l2_plen = 18;
Harald Weltea43f7892009-12-01 18:04:30 +0530595
Holger Hans Peter Freyther17d81e22010-01-06 07:52:55 +0100596 memset(output, GSM_MACBLOCK_PADDING, GSM_MACBLOCK_LEN);
597
Harald Weltee2d0d5f2009-12-19 21:26:54 +0100598 /* ip.access nanoBTS needs l2_plen!! */
Harald Weltefd355a32011-03-04 13:41:31 +0100599 switch (bts->type) {
600 case GSM_BTS_TYPE_NANOBTS:
Harald Weltef383aa12012-07-02 19:51:55 +0200601 case GSM_BTS_TYPE_OSMO_SYSMO:
Harald Weltee2d0d5f2009-12-19 21:26:54 +0100602 *output++ = (l2_plen << 2) | 1;
603 l2_plen++;
Harald Weltefd355a32011-03-04 13:41:31 +0100604 break;
605 default:
606 break;
Harald Weltee2d0d5f2009-12-19 21:26:54 +0100607 }
608
609 si5 = (struct gsm48_system_information_type_5 *) output;
Harald Weltea43f7892009-12-01 18:04:30 +0530610
611 /* l2 pseudo length, not part of msg: 18 */
612 si5->rr_protocol_discriminator = GSM48_PDISC_RR;
613 si5->skip_indicator = 0;
614 si5->system_information = GSM48_MT_RR_SYSINFO_5;
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100615 rc = generate_bcch_chan_list(si5->bcch_frequency_list, bts, 1, 0, 0);
Harald Weltea43f7892009-12-01 18:04:30 +0530616 if (rc < 0)
617 return rc;
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100618 list_arfcn(si5->bcch_frequency_list, 0xce,
619 "Neighbour cells in same band:");
620
621 /* 04.08 9.1.37: L2 Pseudo Length of 18 */
622 return l2_plen;
623}
624
625static int generate_si5bis(uint8_t *output, struct gsm_bts *bts)
626{
627 struct gsm48_system_information_type_5bis *si5b;
628 int rc, l2_plen = 18;
629 int n;
630
631 memset(output, GSM_MACBLOCK_PADDING, GSM_MACBLOCK_LEN);
632
633 /* ip.access nanoBTS needs l2_plen!! */
634 switch (bts->type) {
635 case GSM_BTS_TYPE_NANOBTS:
Harald Weltef383aa12012-07-02 19:51:55 +0200636 case GSM_BTS_TYPE_OSMO_SYSMO:
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100637 *output++ = (l2_plen << 2) | 1;
638 l2_plen++;
639 break;
640 default:
641 break;
642 }
643
644 si5b = (struct gsm48_system_information_type_5bis *) output;
645
646 /* l2 pseudo length, not part of msg: 18 */
647 si5b->rr_protocol_discriminator = GSM48_PDISC_RR;
648 si5b->skip_indicator = 0;
649 si5b->system_information = GSM48_MT_RR_SYSINFO_5bis;
650 rc = generate_bcch_chan_list(si5b->bcch_frequency_list, bts, 1, 1, 0);
651 if (rc < 0)
652 return rc;
653 n = list_arfcn(si5b->bcch_frequency_list, 0xce,
654 "Neighbour cells in same band, but outside P-GSM:");
655 if (n) {
656 /* indicate in SI5 and SI5bis: there is an extension */
657 struct gsm48_system_information_type_5 *si5 =
658 (struct gsm48_system_information_type_5 *)
659 bts->si_buf[SYSINFO_TYPE_5];
660 si5->bcch_frequency_list[0] |= 0x20;
661 si5b->bcch_frequency_list[0] |= 0x20;
662 } else
663 bts->si_valid &= ~(1 << SYSINFO_TYPE_5bis);
664
665 /* 04.08 9.1.37: L2 Pseudo Length of 18 */
666 return l2_plen;
667}
668
669static int generate_si5ter(uint8_t *output, struct gsm_bts *bts)
670{
671 struct gsm48_system_information_type_5ter *si5t;
672 int rc, l2_plen = 18;
673 int n;
674
675 memset(output, GSM_MACBLOCK_PADDING, GSM_MACBLOCK_LEN);
676
677 /* ip.access nanoBTS needs l2_plen!! */
678 switch (bts->type) {
679 case GSM_BTS_TYPE_NANOBTS:
Harald Weltef383aa12012-07-02 19:51:55 +0200680 case GSM_BTS_TYPE_OSMO_SYSMO:
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100681 *output++ = (l2_plen << 2) | 1;
682 l2_plen++;
683 break;
684 default:
685 break;
686 }
687
688 si5t = (struct gsm48_system_information_type_5ter *) output;
689
690 /* l2 pseudo length, not part of msg: 18 */
691 si5t->rr_protocol_discriminator = GSM48_PDISC_RR;
692 si5t->skip_indicator = 0;
693 si5t->system_information = GSM48_MT_RR_SYSINFO_5ter;
694 rc = generate_bcch_chan_list(si5t->bcch_frequency_list, bts, 1, 0, 1);
695 if (rc < 0)
696 return rc;
697 n = list_arfcn(si5t->bcch_frequency_list, 0x8e,
698 "Neighbour cells in different band:");
699 if (!n)
700 bts->si_valid &= ~(1 << SYSINFO_TYPE_5ter);
Harald Weltea43f7892009-12-01 18:04:30 +0530701
702 /* 04.08 9.1.37: L2 Pseudo Length of 18 */
Harald Weltee2d0d5f2009-12-19 21:26:54 +0100703 return l2_plen;
Harald Weltea43f7892009-12-01 18:04:30 +0530704}
705
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200706static int generate_si6(uint8_t *output, struct gsm_bts *bts)
Harald Weltea43f7892009-12-01 18:04:30 +0530707{
Harald Weltee2d0d5f2009-12-19 21:26:54 +0100708 struct gsm48_system_information_type_6 *si6;
709 int l2_plen = 11;
Harald Weltea43f7892009-12-01 18:04:30 +0530710
Holger Hans Peter Freyther17d81e22010-01-06 07:52:55 +0100711 memset(output, GSM_MACBLOCK_PADDING, GSM_MACBLOCK_LEN);
712
Harald Weltee2d0d5f2009-12-19 21:26:54 +0100713 /* ip.access nanoBTS needs l2_plen!! */
Harald Weltefd355a32011-03-04 13:41:31 +0100714 switch (bts->type) {
715 case GSM_BTS_TYPE_NANOBTS:
Harald Weltef383aa12012-07-02 19:51:55 +0200716 case GSM_BTS_TYPE_OSMO_SYSMO:
Harald Weltee2d0d5f2009-12-19 21:26:54 +0100717 *output++ = (l2_plen << 2) | 1;
718 l2_plen++;
Harald Weltefd355a32011-03-04 13:41:31 +0100719 break;
720 default:
721 break;
Harald Weltee2d0d5f2009-12-19 21:26:54 +0100722 }
723
724 si6 = (struct gsm48_system_information_type_6 *) output;
Harald Weltea43f7892009-12-01 18:04:30 +0530725
726 /* l2 pseudo length, not part of msg: 11 */
727 si6->rr_protocol_discriminator = GSM48_PDISC_RR;
728 si6->skip_indicator = 0;
729 si6->system_information = GSM48_MT_RR_SYSINFO_6;
730 si6->cell_identity = htons(bts->cell_identity);
Harald Welteafedeab2010-03-04 10:55:40 +0100731 gsm48_generate_lai(&si6->lai, bts->network->country_code,
732 bts->network->network_code,
733 bts->location_area_code);
Harald Weltea43f7892009-12-01 18:04:30 +0530734 si6->cell_options = bts->si_common.cell_options;
735 si6->ncc_permitted = bts->si_common.ncc_permitted;
736
737 /* SI6 Rest Octets: 10.5.2.35a: PCH / NCH info, VBS/VGCS options */
738
Harald Weltee2d0d5f2009-12-19 21:26:54 +0100739 return l2_plen;
Harald Weltea43f7892009-12-01 18:04:30 +0530740}
741
742static struct gsm48_si13_info si13_default = {
743 .cell_opts = {
Harald Welte85849182010-06-02 12:19:21 +0200744 .nmo = GPRS_NMO_II,
Harald Weltea4b16652010-05-31 12:54:23 +0200745 .t3168 = 2000,
Andreas Eversbergbecc89a2012-09-23 08:14:51 +0200746 .t3192 = 1500,
Harald Welte97a282b2010-03-14 15:37:43 +0800747 .drx_timer_max = 3,
Harald Weltea43f7892009-12-01 18:04:30 +0530748 .bs_cv_max = 15,
Sylvain Munaut851f1202011-10-17 13:56:02 +0200749 .ext_info_present = 0,
Harald Welteda0586a2010-04-18 14:49:05 +0200750 .ext_info = {
751 /* The values below are just guesses ! */
Harald Weltea06fea02010-04-18 15:53:40 +0200752 .egprs_supported = 0,
Harald Welteda0586a2010-04-18 14:49:05 +0200753 .use_egprs_p_ch_req = 1,
Harald Weltea4b16652010-05-31 12:54:23 +0200754 .bep_period = 5,
Harald Welteda0586a2010-04-18 14:49:05 +0200755 .pfc_supported = 0,
756 .dtm_supported = 0,
757 .bss_paging_coordination = 0,
758 },
Harald Weltea43f7892009-12-01 18:04:30 +0530759 },
760 .pwr_ctrl_pars = {
Harald Weltec15d0ac2012-10-08 21:22:08 +0200761 .alpha = 0, /* a = 0.0 */
Harald Weltea4b16652010-05-31 12:54:23 +0200762 .t_avg_w = 16,
763 .t_avg_t = 16,
Harald Weltea43f7892009-12-01 18:04:30 +0530764 .pc_meas_chan = 0, /* downling measured on CCCH */
Harald Weltea4b16652010-05-31 12:54:23 +0200765 .n_avg_i = 8,
Harald Weltea43f7892009-12-01 18:04:30 +0530766 },
Harald Welte97a282b2010-03-14 15:37:43 +0800767 .bcch_change_mark = 1,
Harald Weltea43f7892009-12-01 18:04:30 +0530768 .si_change_field = 0,
769 .pbcch_present = 0,
770 {
771 .no_pbcch = {
Harald Welte97a282b2010-03-14 15:37:43 +0800772 .rac = 0, /* needs to be patched */
Harald Weltea43f7892009-12-01 18:04:30 +0530773 .spgc_ccch_sup = 0,
774 .net_ctrl_ord = 0,
Harald Welte97a282b2010-03-14 15:37:43 +0800775 .prio_acc_thr = 6,
Harald Weltea43f7892009-12-01 18:04:30 +0530776 },
777 },
778};
779
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200780static int generate_si13(uint8_t *output, struct gsm_bts *bts)
Harald Weltea43f7892009-12-01 18:04:30 +0530781{
782 struct gsm48_system_information_type_13 *si13 =
783 (struct gsm48_system_information_type_13 *) output;
784 int ret;
785
786 memset(si13, GSM_MACBLOCK_PADDING, GSM_MACBLOCK_LEN);
787
788 si13->header.rr_protocol_discriminator = GSM48_PDISC_RR;
789 si13->header.skip_indicator = 0;
790 si13->header.system_information = GSM48_MT_RR_SYSINFO_13;
791
Harald Welte97a282b2010-03-14 15:37:43 +0800792 si13_default.no_pbcch.rac = bts->gprs.rac;
Andreas Eversberg0c8f9ca2013-03-16 16:31:26 +0100793 si13_default.no_pbcch.net_ctrl_ord = bts->gprs.net_ctrl_ord;
Harald Welte97a282b2010-03-14 15:37:43 +0800794
Holger Hans Peter Freytherb92a5382014-11-21 10:00:39 +0100795 /* Information about the other SIs */
796 si13_default.bcch_change_mark = bts->bcch_change_mark;
797
Harald Weltea43f7892009-12-01 18:04:30 +0530798 ret = rest_octets_si13(si13->rest_octets, &si13_default);
799 if (ret < 0)
800 return ret;
801
Holger Hans Peter Freyther1c6f3942010-06-16 12:05:56 +0800802 /* length is coded in bit 2 an up */
803 si13->header.l2_plen = 0x01;
Harald Weltea43f7892009-12-01 18:04:30 +0530804
Holger Hans Peter Freyther7ec448d2010-01-06 07:52:31 +0100805 return sizeof (*si13) + ret;
Harald Weltea43f7892009-12-01 18:04:30 +0530806}
807
Harald Welte7401ae62010-06-15 16:44:12 +0200808typedef int (*gen_si_fn_t)(uint8_t *output, struct gsm_bts *bts);
809
810static const gen_si_fn_t gen_si_fn[_MAX_SYSINFO_TYPE] = {
811 [SYSINFO_TYPE_1] = &generate_si1,
812 [SYSINFO_TYPE_2] = &generate_si2,
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100813 [SYSINFO_TYPE_2bis] = &generate_si2bis,
814 [SYSINFO_TYPE_2ter] = &generate_si2ter,
Harald Welte7401ae62010-06-15 16:44:12 +0200815 [SYSINFO_TYPE_3] = &generate_si3,
816 [SYSINFO_TYPE_4] = &generate_si4,
817 [SYSINFO_TYPE_5] = &generate_si5,
Andreas Eversbergc50543b2012-02-29 09:04:07 +0100818 [SYSINFO_TYPE_5bis] = &generate_si5bis,
819 [SYSINFO_TYPE_5ter] = &generate_si5ter,
Harald Welte7401ae62010-06-15 16:44:12 +0200820 [SYSINFO_TYPE_6] = &generate_si6,
821 [SYSINFO_TYPE_13] = &generate_si13,
822};
823
Harald Welte7401ae62010-06-15 16:44:12 +0200824int gsm_generate_si(struct gsm_bts *bts, enum osmo_sysinfo_type si_type)
825{
826 gen_si_fn_t gen_si;
827
Harald Welte4511d892010-04-18 15:51:20 +0200828 switch (bts->gprs.mode) {
829 case BTS_GPRS_EGPRS:
Harald Weltea06fea02010-04-18 15:53:40 +0200830 si13_default.cell_opts.ext_info_present = 1;
831 si13_default.cell_opts.ext_info.egprs_supported = 1;
832 /* fallthrough */
Harald Welte4511d892010-04-18 15:51:20 +0200833 case BTS_GPRS_GPRS:
834 si_info.gprs_ind.present = 1;
835 break;
836 case BTS_GPRS_NONE:
837 si_info.gprs_ind.present = 0;
838 break;
839 }
Harald Welte1f893292010-03-14 23:46:48 +0800840
Sylvain Munaute0b06b02010-11-28 18:17:28 +0100841 memcpy(&si_info.selection_params,
842 &bts->si_common.cell_ro_sel_par,
843 sizeof(struct gsm48_si_selection_params));
844
Harald Welte7401ae62010-06-15 16:44:12 +0200845 gen_si = gen_si_fn[si_type];
846 if (!gen_si)
Harald Weltea43f7892009-12-01 18:04:30 +0530847 return -EINVAL;
Harald Weltea43f7892009-12-01 18:04:30 +0530848
Harald Welte7401ae62010-06-15 16:44:12 +0200849 return gen_si(bts->si_buf[si_type], bts);
Harald Weltea43f7892009-12-01 18:04:30 +0530850}