blob: f8f2eabd0f24bbb3eee9cda22ab1d882a725ee90 [file] [log] [blame]
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02001/*! \file gsm_04_08.h
2 * GSM TS 04.08 definitions. */
3
Sylvain Munaut12ba7782014-06-16 10:13:40 +02004#pragma once
Harald Welteec8b4502010-02-20 20:34:29 +01005
6#include <stdint.h>
Maxfe65fa72016-05-10 17:17:05 +02007#include <stdbool.h>
Harald Welteec8b4502010-02-20 20:34:29 +01008
Maxfb348ee2016-03-30 21:14:53 +02009#include <osmocom/core/utils.h>
Ruben Undheim720ac4a2016-05-27 22:03:59 +020010#include <osmocom/core/endian.h>
11
Pau Espin Pedrol2272a032019-11-04 11:03:37 +010012#include <osmocom/gsm/gsm_utils.h>
13
Harald Welteec8b4502010-02-20 20:34:29 +010014struct gsm_lchan;
15
Andreas Eversberg014cb872010-07-12 09:11:00 +020016/* Chapter 10.5.1.5 */
Harald Welteec8b4502010-02-20 20:34:29 +010017struct gsm48_classmark1 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +010018#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +020019 uint8_t pwr_lev:3,
Harald Welteec8b4502010-02-20 20:34:29 +010020 a5_1:1,
Andreas Eversberg014cb872010-07-12 09:11:00 +020021 es_ind:1,
22 rev_lev:2,
23 spare:1;
Neels Hofmeyrb2600392018-11-16 00:20:39 +010024#elif OSMO_IS_BIG_ENDIAN
25/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
26 uint8_t spare:1, rev_lev:2, es_ind:1, a5_1:1, pwr_lev:3;
27#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +020028} __attribute__ ((packed));
29
30/* Chapter 10.5.1.6 */
31struct gsm48_classmark2 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +010032#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +020033 uint8_t pwr_lev:3,
34 a5_1:1,
35 es_ind:1,
36 rev_lev:2,
37 spare:1;
38 uint8_t fc:1,
39 vgcs:1,
40 vbs:1,
41 sm_cap:1,
42 ss_scr:2,
43 ps_cap:1,
44 spare2:1;
45 uint8_t a5_2:1,
46 a5_3:1,
47 cmsp:1,
48 solsa:1,
49 spare3:1,
50 lcsva_cap:1,
51 spare4:1,
52 cm3:1;
Neels Hofmeyrb2600392018-11-16 00:20:39 +010053#elif OSMO_IS_BIG_ENDIAN
54/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
55 uint8_t spare:1, rev_lev:2, es_ind:1, a5_1:1, pwr_lev:3;
56 uint8_t spare2:1, ps_cap:1, ss_scr:2, sm_cap:1, vbs:1, vgcs:1, fc:1;
57 uint8_t cm3:1, spare4:1, lcsva_cap:1, spare3:1, solsa:1, cmsp:1, a5_3:1, a5_2:1;
58#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +020059} __attribute__ ((packed));
60
Neels Hofmeyr7740d262019-01-16 16:53:26 +010061struct osmo_gsm48_classmark {
62 bool classmark1_set;
63 struct gsm48_classmark1 classmark1;
64 uint8_t classmark2_len;
65 struct gsm48_classmark2 classmark2;
66 uint8_t classmark3_len;
67 uint8_t classmark3[14]; /* if cm3 gets extended by spec, it will be truncated */
68};
69
70bool osmo_gsm48_classmark_is_r99(const struct osmo_gsm48_classmark *cm);
71bool osmo_gsm48_classmark1_is_r99(const struct gsm48_classmark1 *cm1);
72bool osmo_gsm48_classmark2_is_r99(const struct gsm48_classmark2 *cm2, uint8_t cm2_len);
73int osmo_gsm48_classmark_supports_a5(const struct osmo_gsm48_classmark *cm, uint8_t a5);
74const char *osmo_gsm48_classmark_a5_name(const struct osmo_gsm48_classmark *cm);
Harald Welte4a62eda2019-03-18 18:27:00 +010075char *osmo_gsm48_classmark_a5_name_buf(char *buf, size_t buf_len, const struct osmo_gsm48_classmark *cm);
Harald Welte179f3572019-03-18 18:38:47 +010076char *osmo_gsm48_classmark_a5_name_c(const void *ctx, const struct osmo_gsm48_classmark *cm);
Neels Hofmeyr7740d262019-01-16 16:53:26 +010077void osmo_gsm48_classmark_update(struct osmo_gsm48_classmark *dst, const struct osmo_gsm48_classmark *src);
Pau Espin Pedrolb99f4ca2019-10-31 13:35:22 +010078int8_t osmo_gsm48_rfpowercap2powerclass(enum gsm_band band, uint8_t rf_power_cap);
Andreas Eversberg014cb872010-07-12 09:11:00 +020079/* Chapter 10.5.2.1b.3 */
80struct gsm48_range_1024 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +010081#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +020082 uint8_t w1_hi:2,
83 f0:1,
84 form_id:5;
85 uint8_t w1_lo;
86 uint8_t w2_hi;
87 uint8_t w3_hi:7,
88 w2_lo:1;
89 uint8_t w4_hi:6,
90 w3_lo:2;
91 uint8_t w5_hi:6,
92 w4_lo:2;
93 uint8_t w6_hi:6,
94 w5_lo:2;
95 uint8_t w7_hi:6,
96 w6_lo:2;
97 uint8_t w8_hi:6,
98 w7_lo:2;
99 uint8_t w9:7,
100 w8_lo:1;
101 uint8_t w11_hi:1,
102 w10:7;
103 uint8_t w12_hi:2,
104 w11_lo:6;
105 uint8_t w13_hi:3,
106 w12_lo:5;
107 uint8_t w14_hi:4,
108 w13_lo:4;
109 uint8_t w15_hi:5,
110 w14_lo:3;
111 uint8_t w16:6,
112 w15_lo:2;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100113#elif OSMO_IS_BIG_ENDIAN
114/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
115 uint8_t form_id:5, f0:1, w1_hi:2;
116 uint8_t w1_lo;
117 uint8_t w2_hi;
118 uint8_t w2_lo:1, w3_hi:7;
119 uint8_t w3_lo:2, w4_hi:6;
120 uint8_t w4_lo:2, w5_hi:6;
121 uint8_t w5_lo:2, w6_hi:6;
122 uint8_t w6_lo:2, w7_hi:6;
123 uint8_t w7_lo:2, w8_hi:6;
124 uint8_t w8_lo:1, w9:7;
125 uint8_t w10:7, w11_hi:1;
126 uint8_t w11_lo:6, w12_hi:2;
127 uint8_t w12_lo:5, w13_hi:3;
128 uint8_t w13_lo:4, w14_hi:4;
129 uint8_t w14_lo:3, w15_hi:5;
130 uint8_t w15_lo:2, w16:6;
131#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200132} __attribute__ ((packed));
133
134/* Chapter 10.5.2.1b.4 */
135struct gsm48_range_512 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100136#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200137 uint8_t orig_arfcn_hi:1,
138 form_id:7;
139 uint8_t orig_arfcn_mid;
140 uint8_t w1_hi:7,
141 orig_arfcn_lo:1;
142 uint8_t w2_hi:6,
143 w1_lo:2;
144 uint8_t w3_hi:6,
145 w2_lo:2;
146 uint8_t w4_hi:6,
147 w3_lo:2;
148 uint8_t w5:7,
149 w4_lo:1;
150 uint8_t w7_hi:1,
151 w6:7;
152 uint8_t w8_hi:2,
153 w7_lo:6;
154 uint8_t w9_hi:4,
155 w8_lo:4;
156 uint8_t w10:6,
157 w9_lo:2;
158 uint8_t w12_hi:2,
159 w11:6;
160 uint8_t w13_hi:4,
161 w12_lo:4;
162 uint8_t w14:6,
163 w13_lo:2;
164 uint8_t w16_hi:2,
165 w15:6;
166 uint8_t w17:5,
167 w16_lo:3;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100168#elif OSMO_IS_BIG_ENDIAN
169/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
170 uint8_t form_id:7, orig_arfcn_hi:1;
171 uint8_t orig_arfcn_mid;
172 uint8_t orig_arfcn_lo:1, w1_hi:7;
173 uint8_t w1_lo:2, w2_hi:6;
174 uint8_t w2_lo:2, w3_hi:6;
175 uint8_t w3_lo:2, w4_hi:6;
176 uint8_t w4_lo:1, w5:7;
177 uint8_t w6:7, w7_hi:1;
178 uint8_t w7_lo:6, w8_hi:2;
179 uint8_t w8_lo:4, w9_hi:4;
180 uint8_t w9_lo:2, w10:6;
181 uint8_t w11:6, w12_hi:2;
182 uint8_t w12_lo:4, w13_hi:4;
183 uint8_t w13_lo:2, w14:6;
184 uint8_t w15:6, w16_hi:2;
185 uint8_t w16_lo:3, w17:5;
186#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200187} __attribute__ ((packed));
188
189/* Chapter 10.5.2.1b.5 */
190struct gsm48_range_256 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100191#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200192 uint8_t orig_arfcn_hi:1,
193 form_id:7;
194 uint8_t orig_arfcn_mid;
195 uint8_t w1_hi:7,
196 orig_arfcn_lo:1;
197 uint8_t w2:7,
198 w1_lo:1;
199 uint8_t w4_hi:1,
200 w3:7;
201 uint8_t w5_hi:3,
202 w4_lo:5;
203 uint8_t w6_hi:5,
204 w5_lo:3;
205 uint8_t w8_hi:1,
206 w7:6,
207 w6_lo:1;
208 uint8_t w9_hi:4,
209 w8_lo:4;
210 uint8_t w11_hi:2,
211 w10:5,
212 w9_lo:1;
213 uint8_t w12:5,
214 w11_lo:3;
215 uint8_t w14_hi:3,
216 w13:5;
217 uint8_t w16_hi:1,
218 w15:5,
219 w14_lo:2;
220 uint8_t w18_hi:1,
221 w17:4,
222 w16_lo:3;
223 uint8_t w20_hi:1,
224 w19:4,
225 w18_lo:3;
226 uint8_t spare:1,
227 w21:4,
228 w20_lo:3;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100229#elif OSMO_IS_BIG_ENDIAN
230/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
231 uint8_t form_id:7, orig_arfcn_hi:1;
232 uint8_t orig_arfcn_mid;
233 uint8_t orig_arfcn_lo:1, w1_hi:7;
234 uint8_t w1_lo:1, w2:7;
235 uint8_t w3:7, w4_hi:1;
236 uint8_t w4_lo:5, w5_hi:3;
237 uint8_t w5_lo:3, w6_hi:5;
238 uint8_t w6_lo:1, w7:6, w8_hi:1;
239 uint8_t w8_lo:4, w9_hi:4;
240 uint8_t w9_lo:1, w10:5, w11_hi:2;
241 uint8_t w11_lo:3, w12:5;
242 uint8_t w13:5, w14_hi:3;
243 uint8_t w14_lo:2, w15:5, w16_hi:1;
244 uint8_t w16_lo:3, w17:4, w18_hi:1;
245 uint8_t w18_lo:3, w19:4, w20_hi:1;
246 uint8_t w20_lo:3, w21:4, spare:1;
247#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200248} __attribute__ ((packed));
249
250/* Chapter 10.5.2.1b.6 */
251struct gsm48_range_128 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100252#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200253 uint8_t orig_arfcn_hi:1,
254 form_id:7;
255 uint8_t orig_arfcn_mid;
256 uint8_t w1:7,
257 orig_arfcn_lo:1;
258 uint8_t w3_hi:2,
259 w2:6;
260 uint8_t w4_hi:4,
261 w3_lo:4;
262 uint8_t w6_hi:2,
263 w5:5,
264 w4_lo:1;
265 uint8_t w7:5,
266 w6_lo:3;
267 uint8_t w9:4,
268 w8:4;
269 uint8_t w11:4,
270 w10:4;
271 uint8_t w13:4,
272 w12:4;
273 uint8_t w15:4,
274 w14:4;
275 uint8_t w18_hi:2,
276 w17:3,
277 w16:3;
278 uint8_t w21_hi:1,
279 w20:3,
280 w19:3,
281 w18_lo:1;
282 uint8_t w23:3,
283 w22:3,
284 w21_lo:2;
285 uint8_t w26_hi:2,
286 w25:3,
287 w24:3;
288 uint8_t spare:1,
289 w28:3,
290 w27:3,
291 w26_lo:1;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100292#elif OSMO_IS_BIG_ENDIAN
293/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
294 uint8_t form_id:7, orig_arfcn_hi:1;
295 uint8_t orig_arfcn_mid;
296 uint8_t orig_arfcn_lo:1, w1:7;
297 uint8_t w2:6, w3_hi:2;
298 uint8_t w3_lo:4, w4_hi:4;
299 uint8_t w4_lo:1, w5:5, w6_hi:2;
300 uint8_t w6_lo:3, w7:5;
301 uint8_t w8:4, w9:4;
302 uint8_t w10:4, w11:4;
303 uint8_t w12:4, w13:4;
304 uint8_t w14:4, w15:4;
305 uint8_t w16:3, w17:3, w18_hi:2;
306 uint8_t w18_lo:1, w19:3, w20:3, w21_hi:1;
307 uint8_t w21_lo:2, w22:3, w23:3;
308 uint8_t w24:3, w25:3, w26_hi:2;
309 uint8_t w26_lo:1, w27:3, w28:3, spare:1;
310#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200311} __attribute__ ((packed));
312
313/* Chapter 10.5.2.1b.7 */
314struct gsm48_var_bit {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100315#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200316 uint8_t orig_arfcn_hi:1,
317 form_id:7;
318 uint8_t orig_arfcn_mid;
319 uint8_t rrfcn1_7:7,
320 orig_arfcn_lo:1;
321 uint8_t rrfcn8_111[13];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100322#elif OSMO_IS_BIG_ENDIAN
323/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
324 uint8_t form_id:7, orig_arfcn_hi:1;
325 uint8_t orig_arfcn_mid;
326 uint8_t orig_arfcn_lo:1, rrfcn1_7:7;
327 uint8_t rrfcn8_111[13];
328#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100329} __attribute__ ((packed));
330
331/* Chapter 10.5.2.5 */
332struct gsm48_chan_desc {
333 uint8_t chan_nr;
334 union {
335 struct {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100336#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100337 uint8_t maio_high:4,
338 h:1,
339 tsc:3;
340 uint8_t hsn:6,
341 maio_low:2;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100342#elif OSMO_IS_BIG_ENDIAN
343/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
344 uint8_t tsc:3, h:1, maio_high:4;
345 uint8_t maio_low:2, hsn:6;
346#endif
Andreas Eversberg4b332d72012-02-07 20:02:17 +0100347 } __attribute__ ((packed)) h1;
Harald Welteec8b4502010-02-20 20:34:29 +0100348 struct {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100349#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100350 uint8_t arfcn_high:2,
351 spare:2,
352 h:1,
353 tsc:3;
354 uint8_t arfcn_low;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100355#elif OSMO_IS_BIG_ENDIAN
356/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
357 uint8_t tsc:3, h:1, spare:2, arfcn_high:2;
358 uint8_t arfcn_low;
359#endif
Andreas Eversberg4b332d72012-02-07 20:02:17 +0100360 } __attribute__ ((packed)) h0;
361 } __attribute__ ((packed));
Harald Welteec8b4502010-02-20 20:34:29 +0100362} __attribute__ ((packed));
363
Andreas Eversberg014cb872010-07-12 09:11:00 +0200364/* Chapter 10.5.2.20 */
365struct gsm48_meas_res {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100366#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200367 uint8_t rxlev_full:6,
368 dtx_used:1,
369 ba_used:1;
370 uint8_t rxlev_sub:6,
371 meas_valid:1,
372 spare:1;
373 uint8_t no_nc_n_hi:1,
374 rxqual_sub:3,
375 rxqual_full:3,
376 spare2:1;
377 uint8_t rxlev_nc1:6,
378 no_nc_n_lo:2;
379 uint8_t bsic_nc1_hi:3,
380 bcch_f_nc1:5;
381 uint8_t rxlev_nc2_hi:5,
382 bsic_nc1_lo:3;
383 uint8_t bsic_nc2_hi:2,
384 bcch_f_nc2:5,
385 rxlev_nc2_lo:1;
386 uint8_t rxlev_nc3_hi:4,
387 bsic_nc2_lo:4;
388 uint8_t bsic_nc3_hi:1,
389 bcch_f_nc3:5,
390 rxlev_nc3_lo:2;
391 uint8_t rxlev_nc4_hi:3,
392 bsic_nc3_lo:5;
393 uint8_t bcch_f_nc4:5,
394 rxlev_nc4_lo:3;
395 uint8_t rxlev_nc5_hi:2,
396 bsic_nc4:6;
397 uint8_t bcch_f_nc5_hi:4,
398 rxlev_nc5_lo:4;
399 uint8_t rxlev_nc6_hi:1,
400 bsic_nc5:6,
401 bcch_f_nc5_lo:1;
402 uint8_t bcch_f_nc6_hi:3,
403 rxlev_nc6_lo:5;
404 uint8_t bsic_nc6:6,
405 bcch_f_nc6_lo:2;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100406#elif OSMO_IS_BIG_ENDIAN
407/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
408 uint8_t ba_used:1, dtx_used:1, rxlev_full:6;
409 uint8_t spare:1, meas_valid:1, rxlev_sub:6;
410 uint8_t spare2:1, rxqual_full:3, rxqual_sub:3, no_nc_n_hi:1;
411 uint8_t no_nc_n_lo:2, rxlev_nc1:6;
412 uint8_t bcch_f_nc1:5, bsic_nc1_hi:3;
413 uint8_t bsic_nc1_lo:3, rxlev_nc2_hi:5;
414 uint8_t rxlev_nc2_lo:1, bcch_f_nc2:5, bsic_nc2_hi:2;
415 uint8_t bsic_nc2_lo:4, rxlev_nc3_hi:4;
416 uint8_t rxlev_nc3_lo:2, bcch_f_nc3:5, bsic_nc3_hi:1;
417 uint8_t bsic_nc3_lo:5, rxlev_nc4_hi:3;
418 uint8_t rxlev_nc4_lo:3, bcch_f_nc4:5;
419 uint8_t bsic_nc4:6, rxlev_nc5_hi:2;
420 uint8_t rxlev_nc5_lo:4, bcch_f_nc5_hi:4;
421 uint8_t bcch_f_nc5_lo:1, bsic_nc5:6, rxlev_nc6_hi:1;
422 uint8_t rxlev_nc6_lo:5, bcch_f_nc6_hi:3;
423 uint8_t bcch_f_nc6_lo:2, bsic_nc6:6;
424#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200425} __attribute__ ((packed));
426
Harald Welteec8b4502010-02-20 20:34:29 +0100427/* Chapter 10.5.2.21aa */
428struct gsm48_multi_rate_conf {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100429#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100430 uint8_t smod : 2,
431 spare: 1,
432 icmi : 1,
433 nscb : 1,
434 ver : 3;
435 uint8_t m4_75 : 1,
436 m5_15 : 1,
437 m5_90 : 1,
438 m6_70 : 1,
439 m7_40 : 1,
440 m7_95 : 1,
441 m10_2 : 1,
442 m12_2 : 1;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100443#elif OSMO_IS_BIG_ENDIAN
444/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
445 uint8_t ver:3, nscb:1, icmi:1, spare:1, smod:2;
446 uint8_t m12_2:1, m10_2:1, m7_95:1, m7_40:1, m6_70:1, m5_90:1, m5_15:1, m4_75:1;
447#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100448} __attribute__((packed));
449
Andreas Eversberg014cb872010-07-12 09:11:00 +0200450/* Chapter 10.5.2.28(a) */
451struct gsm48_power_cmd {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100452#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200453 uint8_t power_level:5,
454 spare:2,
455 atc:1;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100456#elif OSMO_IS_BIG_ENDIAN
457/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
458 uint8_t atc:1, spare:2, power_level:5;
459#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200460} __attribute__((packed));
461
462/* Chapter 10.5.2.29 */
463struct gsm48_rach_control {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100464#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200465 uint8_t re :1,
466 cell_bar :1,
467 tx_integer :4,
468 max_trans :2;
Stefan Sperling18595152018-02-06 13:20:23 +0100469 uint8_t t2; /* ACC 8-15 barred flags */
470 uint8_t t3; /* ACC 0-7 barred flags */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100471#elif OSMO_IS_BIG_ENDIAN
472/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
473 uint8_t max_trans:2, tx_integer:4, cell_bar:1, re:1;
474 uint8_t t2;
475 uint8_t t3;
476#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200477} __attribute__ ((packed));
478
Stefan Sperling18595152018-02-06 13:20:23 +0100479/*
480 * Mark an Access Control Class as barred.
481 * \param[in] rach_control A Rach Control Information Element.
482 * \param[in] acc Access Control Class number (0 - 15) which shall be barred.
483 */
484static inline void gsm48_barr_acc(struct gsm48_rach_control *rach_control, unsigned int acc)
485{
Vadim Yanitskiyb8734ba2019-06-12 15:50:57 +0700486 OSMO_ASSERT(acc <= 15);
Stefan Sperling18595152018-02-06 13:20:23 +0100487 if (acc >= 8)
488 rach_control->t2 |= (1 << (acc - 8));
489 else
490 rach_control->t3 |= (1 << (acc));
491}
492
493/*
494 * Mark an Access Control Class as allowed.
495 * \param[in] rach_control A Rach Control Information Element.
496 * \param[in] acc Access Control Class number (0 - 15) which shall be allowed.
497 */
498static inline void gsm48_allow_acc(struct gsm48_rach_control *rach_control, unsigned int acc)
499{
Vadim Yanitskiyb8734ba2019-06-12 15:50:57 +0700500 OSMO_ASSERT(acc <= 15);
Stefan Sperling18595152018-02-06 13:20:23 +0100501 if (acc >= 8)
502 rach_control->t2 &= ~(1 << (acc - 8));
503 else
504 rach_control->t3 &= ~(1 << (acc));
505}
506
507/*
508 * Indicate whether an Access Control Class is barred.
509 * \param[in] rach_control A Rach Control Information Element.
510 * \param[in] acc Access Control Class number (0 - 15).
511 * \returns true if the Access Control class is barred, false otherwise
512 */
513static inline bool gsm48_acc_is_barred(struct gsm48_rach_control *rach_control, unsigned int acc)
514{
Vadim Yanitskiyb8734ba2019-06-12 15:50:57 +0700515 OSMO_ASSERT(acc <= 15);
Stefan Sperling18595152018-02-06 13:20:23 +0100516 if (acc >= 8)
517 return (rach_control->t2 & (1 << (acc - 8))) != 0;
518 return (rach_control->t3 & (1 << (acc))) != 0;
519}
Andreas Eversberg014cb872010-07-12 09:11:00 +0200520
Harald Welteec8b4502010-02-20 20:34:29 +0100521/* Chapter 10.5.2.30 */
522struct gsm48_req_ref {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100523#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100524 uint8_t ra;
525 uint8_t t3_high:3,
Andreas Eversberg93364fc2010-06-25 02:50:06 +0200526 t1:5;
Harald Welteec8b4502010-02-20 20:34:29 +0100527 uint8_t t2:5,
528 t3_low:3;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100529#elif OSMO_IS_BIG_ENDIAN
530/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
531 uint8_t ra;
532 uint8_t t1:5, t3_high:3;
533 uint8_t t3_low:3, t2:5;
534#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100535} __attribute__ ((packed));
536
Andreas Eversberg014cb872010-07-12 09:11:00 +0200537/* Chapter 10.5.2.38 */
538struct gsm48_start_time {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100539#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200540 uint8_t t3_high:3,
541 t1:5;
542 uint8_t t2:5,
543 t3_low:3;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100544#elif OSMO_IS_BIG_ENDIAN
545/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
546 uint8_t t1:5, t3_high:3;
547 uint8_t t3_low:3, t2:5;
548#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200549} __attribute__ ((packed));
550
551/* Chapter 10.5.2.39 */
552struct gsm48_sync_ind {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100553#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200554 uint8_t si:2,
555 rot:1,
556 nci:1,
557 sync_ie:4;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100558#elif OSMO_IS_BIG_ENDIAN
559/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
560 uint8_t sync_ie:4, nci:1, rot:1, si:2;
561#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200562} __attribute__((packed));
563
Harald Welteec8b4502010-02-20 20:34:29 +0100564/*
565 * Chapter 9.1.5/9.1.6
566 *
567 * For 9.1.6 the chan_desc has the meaning of 10.5.2.5a
568 */
569struct gsm48_chan_mode_modify {
570 struct gsm48_chan_desc chan_desc;
571 uint8_t mode;
572} __attribute__ ((packed));
573
574enum gsm48_chan_mode {
575 GSM48_CMODE_SIGN = 0x00,
576 GSM48_CMODE_SPEECH_V1 = 0x01,
577 GSM48_CMODE_SPEECH_EFR = 0x21,
578 GSM48_CMODE_SPEECH_AMR = 0x41,
579 GSM48_CMODE_DATA_14k5 = 0x0f,
580 GSM48_CMODE_DATA_12k0 = 0x03,
581 GSM48_CMODE_DATA_6k0 = 0x0b,
Bhaskar31e844b2013-05-16 17:06:35 +0530582 GSM48_CMODE_DATA_3k6 = 0x13,
Harald Welteec8b4502010-02-20 20:34:29 +0100583};
584
Maxfb348ee2016-03-30 21:14:53 +0200585extern const struct value_string gsm48_chan_mode_names[];
Philipp Maier5796a212018-07-12 17:48:26 +0200586static inline const char *gsm48_chan_mode_name(enum gsm48_chan_mode val)
587{ return get_value_string(gsm48_chan_mode_names, val); }
Maxfb348ee2016-03-30 21:14:53 +0200588
Harald Welteec8b4502010-02-20 20:34:29 +0100589/* Chapter 9.1.2 */
590struct gsm48_ass_cmd {
591 /* Semantic is from 10.5.2.5a */
592 struct gsm48_chan_desc chan_desc;
593 uint8_t power_command;
594 uint8_t data[0];
595} __attribute__((packed));
596
Andreas Eversbergfa832012010-09-01 23:37:07 +0200597/* Chapter 9.1.13 */
598struct gsm48_frq_redef {
599 /* Semantic is from 10.5.2.5a */
600 struct gsm48_chan_desc chan_desc;
601 uint8_t mob_alloc_len;
602 uint8_t mob_alloc[0];
603} __attribute__((packed));
604
Harald Welte548e3712017-07-10 22:32:08 +0200605/* Chapter 9.1.13b GPRS suspension request */
606struct gsm48_gprs_susp_req {
607 uint32_t tlli;
608 uint8_t ra_id[6];
609 uint8_t cause;
610 uint8_t options[0];
611} __attribute__ ((packed));
612
Harald Welteec8b4502010-02-20 20:34:29 +0100613/* Chapter 10.5.2.2 */
614struct gsm48_cell_desc {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100615#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100616 uint8_t bcc:3,
617 ncc:3,
618 arfcn_hi:2;
619 uint8_t arfcn_lo;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100620#elif OSMO_IS_BIG_ENDIAN
621/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
622 uint8_t arfcn_hi:2, ncc:3, bcc:3;
623 uint8_t arfcn_lo;
624#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100625} __attribute__((packed));
626
627/* Chapter 9.1.15 */
628struct gsm48_ho_cmd {
629 struct gsm48_cell_desc cell_desc;
630 struct gsm48_chan_desc chan_desc;
631 uint8_t ho_ref;
632 uint8_t power_command;
633 uint8_t data[0];
634} __attribute__((packed));
635
636/* Chapter 9.1.18 */
637struct gsm48_imm_ass {
638 uint8_t l2_plen;
639 uint8_t proto_discr;
640 uint8_t msg_type;
641 uint8_t page_mode;
642 struct gsm48_chan_desc chan_desc;
643 struct gsm48_req_ref req_ref;
644 uint8_t timing_advance;
645 uint8_t mob_alloc_len;
646 uint8_t mob_alloc[0];
647} __attribute__ ((packed));
648
Holger Hans Peter Freyther5dcef3c2010-05-15 22:35:25 +0800649/* Chapter 9.1.25 */
650struct gsm48_pag_resp {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100651#if OSMO_IS_LITTLE_ENDIAN
Holger Hans Peter Freyther5dcef3c2010-05-15 22:35:25 +0800652 uint8_t spare:4,
653 key_seq:4;
Pau Espin Pedrolba5a9b92019-11-04 15:41:32 +0100654 union {
655 uint32_t classmark2; /* Backward compatibility */
656 struct {
657 uint8_t cm2_len;
658 struct gsm48_classmark2 cm2;
659 };
660 };
Holger Hans Peter Freyther5dcef3c2010-05-15 22:35:25 +0800661 uint8_t mi_len;
662 uint8_t mi[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100663#elif OSMO_IS_BIG_ENDIAN
664/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
665 uint8_t key_seq:4, spare:4;
Pau Espin Pedrolba5a9b92019-11-04 15:41:32 +0100666 union {
Neels Hofmeyr534f0f42020-05-14 17:28:39 +0200667 uint32_t classmark2;
Pau Espin Pedrolba5a9b92019-11-04 15:41:32 +0100668 struct {
669 uint8_t cm2_len;
670 struct gsm48_classmark2 cm2;
671 };
672 };
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100673 uint8_t mi_len;
674 uint8_t mi[0];
675#endif
Holger Hans Peter Freyther5dcef3c2010-05-15 22:35:25 +0800676} __attribute__ ((packed));
677
Harald Welteec8b4502010-02-20 20:34:29 +0100678/* Chapter 10.5.1.3 */
679struct gsm48_loc_area_id {
680 uint8_t digits[3]; /* BCD! */
681 uint16_t lac;
682} __attribute__ ((packed));
683
684/* Section 9.2.2 */
685struct gsm48_auth_req {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100686#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100687 uint8_t key_seq:4,
688 spare:4;
689 uint8_t rand[16];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100690#elif OSMO_IS_BIG_ENDIAN
691/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
692 uint8_t spare:4, key_seq:4;
693 uint8_t rand[16];
694#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100695} __attribute__ ((packed));
696
Sylvain Munautd005eab2010-06-10 13:30:50 +0200697/* Section 9.2.3 */
698struct gsm48_auth_resp {
699 uint8_t sres[4];
700} __attribute__ ((packed));
701
Harald Welteec8b4502010-02-20 20:34:29 +0100702/* Section 9.2.15 */
703struct gsm48_loc_upd_req {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100704#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100705 uint8_t type:4,
706 key_seq:4;
707 struct gsm48_loc_area_id lai;
708 struct gsm48_classmark1 classmark1;
709 uint8_t mi_len;
710 uint8_t mi[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100711#elif OSMO_IS_BIG_ENDIAN
712/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
713 uint8_t key_seq:4, type:4;
714 struct gsm48_loc_area_id lai;
715 struct gsm48_classmark1 classmark1;
716 uint8_t mi_len;
717 uint8_t mi[0];
718#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100719} __attribute__ ((packed));
720
721/* Section 10.1 */
722struct gsm48_hdr {
723 uint8_t proto_discr;
724 uint8_t msg_type;
725 uint8_t data[0];
726} __attribute__ ((packed));
727
728/* Section 9.1.3x System information Type header */
729struct gsm48_system_information_type_header {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100730#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100731 uint8_t l2_plen;
732 uint8_t rr_protocol_discriminator :4,
Pau Espin Pedrolab6d6cf2019-10-31 13:34:57 +0100733 skip_indicator:4;
Harald Welteec8b4502010-02-20 20:34:29 +0100734 uint8_t system_information;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100735#elif OSMO_IS_BIG_ENDIAN
736/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
737 uint8_t l2_plen;
738 uint8_t skip_indicator:4, rr_protocol_discriminator:4;
739 uint8_t system_information;
740#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100741} __attribute__ ((packed));
742
Harald Welteec8b4502010-02-20 20:34:29 +0100743/* Section 10.5.2.4 Cell Selection Parameters */
744struct gsm48_cell_sel_par {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100745#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100746 uint8_t ms_txpwr_max_ccch:5, /* GSM 05.08 MS-TXPWR-MAX-CCCH */
747 cell_resel_hyst:3; /* GSM 05.08 CELL-RESELECT-HYSTERESIS */
748 uint8_t rxlev_acc_min:6, /* GSM 05.08 RXLEV-ACCESS-MIN */
749 neci:1,
750 acs:1;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100751#elif OSMO_IS_BIG_ENDIAN
752/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
753 uint8_t cell_resel_hyst:3, ms_txpwr_max_ccch:5;
754 uint8_t acs:1, neci:1, rxlev_acc_min:6;
755#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100756} __attribute__ ((packed));
757
Neels Hofmeyrd1c2fc62017-02-21 14:51:40 +0100758/* 3GPP TS 44.018 Section 10.5.2.11 Control Channel Description */
Harald Welteec8b4502010-02-20 20:34:29 +0100759struct gsm48_control_channel_descr {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100760#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100761 uint8_t ccch_conf :3,
762 bs_ag_blks_res :3,
763 att :1,
Neels Hofmeyrd1c2fc62017-02-21 14:51:40 +0100764 mscr :1;
Harald Welteec8b4502010-02-20 20:34:29 +0100765 uint8_t bs_pa_mfrms : 3,
Neels Hofmeyrd1c2fc62017-02-21 14:51:40 +0100766 spare_1 :2,
767 cbq3 :2,
768 spare_2 :1;
Harald Welteec8b4502010-02-20 20:34:29 +0100769 uint8_t t3212;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100770#elif OSMO_IS_BIG_ENDIAN
771/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
772 uint8_t mscr:1, att:1, bs_ag_blks_res:3, ccch_conf:3;
773 uint8_t spare_2:1, cbq3:2, spare_1:2, bs_pa_mfrms:3;
774 uint8_t t3212;
775#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100776} __attribute__ ((packed));
777
Maxfe65fa72016-05-10 17:17:05 +0200778enum gsm48_dtx_mode {
779 GSM48_DTX_MAY_BE_USED,
780 GSM48_DTX_SHALL_BE_USED,
781 GSM48_DTX_SHALL_NOT_BE_USED
782};
783
784/* Cell Options for SI6, SACCH (10.5.2.3a.2) or SI3, BCCH (Table 10.5.2.3.1),
785 3GPP TS 44.018 */
Harald Welteec8b4502010-02-20 20:34:29 +0100786struct gsm48_cell_options {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100787#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100788 uint8_t radio_link_timeout:4,
789 dtx:2,
790 pwrc:1,
Maxfe65fa72016-05-10 17:17:05 +0200791 /* either DN-IND or top bit of DTX IND */
792 d:1;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100793#elif OSMO_IS_BIG_ENDIAN
794/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
795 uint8_t d:1, pwrc:1, dtx:2, radio_link_timeout:4;
796#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100797} __attribute__ ((packed));
798
799/* Section 9.2.9 CM service request */
800struct gsm48_service_request {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100801#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100802 uint8_t cm_service_type : 4,
803 cipher_key_seq : 4;
Pau Espin Pedrolba5a9b92019-11-04 15:41:32 +0100804 union {
805 uint32_t classmark; /* Backward compatibility */
806 struct {
807 uint8_t cm2_len;
808 struct gsm48_classmark2 classmark2;
809 };
810 };
Harald Welteec8b4502010-02-20 20:34:29 +0100811 uint8_t mi_len;
812 uint8_t mi[0];
813 /* optional priority level */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100814#elif OSMO_IS_BIG_ENDIAN
815/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
816 uint8_t cipher_key_seq:4, cm_service_type:4;
Pau Espin Pedrolba5a9b92019-11-04 15:41:32 +0100817 union {
Neels Hofmeyr534f0f42020-05-14 17:28:39 +0200818 uint32_t classmark;
Pau Espin Pedrolba5a9b92019-11-04 15:41:32 +0100819 struct {
820 uint8_t cm2_len;
821 struct gsm48_classmark2 classmark2;
822 };
823 };
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100824 uint8_t mi_len;
825 uint8_t mi[0];
826#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100827} __attribute__ ((packed));
828
829/* Section 9.1.31 System information Type 1 */
830struct gsm48_system_information_type_1 {
831 struct gsm48_system_information_type_header header;
832 uint8_t cell_channel_description[16];
833 struct gsm48_rach_control rach_control;
834 uint8_t rest_octets[0]; /* NCH position on the CCCH */
835} __attribute__ ((packed));
836
837/* Section 9.1.32 System information Type 2 */
838struct gsm48_system_information_type_2 {
839 struct gsm48_system_information_type_header header;
840 uint8_t bcch_frequency_list[16];
841 uint8_t ncc_permitted;
842 struct gsm48_rach_control rach_control;
843} __attribute__ ((packed));
844
Andreas Eversberg014cb872010-07-12 09:11:00 +0200845/* Section 9.1.33 System information Type 2bis */
846struct gsm48_system_information_type_2bis {
847 struct gsm48_system_information_type_header header;
848 uint8_t bcch_frequency_list[16];
849 struct gsm48_rach_control rach_control;
850 uint8_t rest_octets[0];
851} __attribute__ ((packed));
852
853/* Section 9.1.34 System information Type 2ter */
854struct gsm48_system_information_type_2ter {
855 struct gsm48_system_information_type_header header;
856 uint8_t ext_bcch_frequency_list[16];
857 uint8_t rest_octets[0];
858} __attribute__ ((packed));
859
Maxe859aec2016-03-11 12:24:04 +0100860/* Section 9.1.34a System information Type 2quater */
861struct gsm48_system_information_type_2quater {
862 struct gsm48_system_information_type_header header;
863 uint8_t rest_octets[0];
864} __attribute__ ((packed));
865
Harald Welteec8b4502010-02-20 20:34:29 +0100866/* Section 9.1.35 System information Type 3 */
867struct gsm48_system_information_type_3 {
868 struct gsm48_system_information_type_header header;
869 uint16_t cell_identity;
870 struct gsm48_loc_area_id lai;
871 struct gsm48_control_channel_descr control_channel_desc;
872 struct gsm48_cell_options cell_options;
873 struct gsm48_cell_sel_par cell_sel_par;
874 struct gsm48_rach_control rach_control;
875 uint8_t rest_octets[0];
876} __attribute__ ((packed));
877
878/* Section 9.1.36 System information Type 4 */
879struct gsm48_system_information_type_4 {
880 struct gsm48_system_information_type_header header;
881 struct gsm48_loc_area_id lai;
882 struct gsm48_cell_sel_par cell_sel_par;
883 struct gsm48_rach_control rach_control;
884 /* optional CBCH conditional CBCH... followed by
885 mandantory SI 4 Reset Octets
886 */
887 uint8_t data[0];
888} __attribute__ ((packed));
889
890/* Section 9.1.37 System information Type 5 */
891struct gsm48_system_information_type_5 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100892#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100893 uint8_t rr_protocol_discriminator :4,
Pau Espin Pedrolab6d6cf2019-10-31 13:34:57 +0100894 skip_indicator:4;
Harald Welteec8b4502010-02-20 20:34:29 +0100895 uint8_t system_information;
896 uint8_t bcch_frequency_list[16];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100897#elif OSMO_IS_BIG_ENDIAN
898/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
899 uint8_t skip_indicator:4, rr_protocol_discriminator:4;
900 uint8_t system_information;
901 uint8_t bcch_frequency_list[16];
902#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100903} __attribute__ ((packed));
904
Andreas Eversberg014cb872010-07-12 09:11:00 +0200905/* Section 9.1.38 System information Type 5bis */
906struct gsm48_system_information_type_5bis {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100907#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200908 uint8_t rr_protocol_discriminator :4,
909 skip_indicator:4;
910 uint8_t system_information;
911 uint8_t bcch_frequency_list[16];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100912#elif OSMO_IS_BIG_ENDIAN
913/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
914 uint8_t skip_indicator:4, rr_protocol_discriminator:4;
915 uint8_t system_information;
916 uint8_t bcch_frequency_list[16];
917#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200918} __attribute__ ((packed));
919
920/* Section 9.1.39 System information Type 5ter */
921struct gsm48_system_information_type_5ter {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100922#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200923 uint8_t rr_protocol_discriminator :4,
924 skip_indicator:4;
925 uint8_t system_information;
926 uint8_t bcch_frequency_list[16];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100927#elif OSMO_IS_BIG_ENDIAN
928/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
929 uint8_t skip_indicator:4, rr_protocol_discriminator:4;
930 uint8_t system_information;
931 uint8_t bcch_frequency_list[16];
932#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200933} __attribute__ ((packed));
934
Harald Welteec8b4502010-02-20 20:34:29 +0100935/* Section 9.1.40 System information Type 6 */
936struct gsm48_system_information_type_6 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100937#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100938 uint8_t rr_protocol_discriminator :4,
Pau Espin Pedrolab6d6cf2019-10-31 13:34:57 +0100939 skip_indicator:4;
Harald Welteec8b4502010-02-20 20:34:29 +0100940 uint8_t system_information;
941 uint16_t cell_identity;
942 struct gsm48_loc_area_id lai;
943 struct gsm48_cell_options cell_options;
944 uint8_t ncc_permitted;
945 uint8_t rest_octets[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100946#elif OSMO_IS_BIG_ENDIAN
947/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
948 uint8_t skip_indicator:4, rr_protocol_discriminator:4;
949 uint8_t system_information;
950 uint16_t cell_identity;
951 struct gsm48_loc_area_id lai;
952 struct gsm48_cell_options cell_options;
953 uint8_t ncc_permitted;
954 uint8_t rest_octets[0];
955#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100956} __attribute__ ((packed));
957
958/* Section 9.1.43a System Information type 13 */
959struct gsm48_system_information_type_13 {
960 struct gsm48_system_information_type_header header;
961 uint8_t rest_octets[0];
962} __attribute__ ((packed));
963
964/* Section 9.2.12 IMSI Detach Indication */
965struct gsm48_imsi_detach_ind {
966 struct gsm48_classmark1 classmark1;
967 uint8_t mi_len;
968 uint8_t mi[0];
969} __attribute__ ((packed));
970
Andreas Eversberg014cb872010-07-12 09:11:00 +0200971/* Section 9.1.1 */
972struct gsm48_add_ass {
973 /* Semantic is from 10.5.2.5 */
974 struct gsm48_chan_desc chan_desc;
975 uint8_t data[0];
976} __attribute__((packed));
977
978/* Section 9.1.3 */
979struct gsm48_ass_cpl {
980 uint8_t rr_cause;
981} __attribute__((packed));
982
983/* Section 9.1.4 */
984struct gsm48_ass_fail {
985 uint8_t rr_cause;
986} __attribute__((packed));
987
Andreas Eversbergfa832012010-09-01 23:37:07 +0200988/* Section 9.1.3 */
989struct gsm48_ho_cpl {
990 uint8_t rr_cause;
991 uint8_t data[0];
992} __attribute__((packed));
993
994/* Section 9.1.4 */
995struct gsm48_ho_fail {
996 uint8_t rr_cause;
997} __attribute__((packed));
998
Andreas Eversberg014cb872010-07-12 09:11:00 +0200999/* Section 9.1.7 */
1000struct gsm48_chan_rel {
1001 uint8_t rr_cause;
1002 uint8_t data[0];
1003} __attribute__((packed));
1004
1005/* Section 9.1.9 */
1006struct gsm48_cip_mode_cmd {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001007#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +02001008 uint8_t sc:1,
1009 alg_id:3,
Sylvain Munaut77b6f6c2010-09-17 13:55:45 +02001010 cr:1,
1011 spare:3;
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001012#elif OSMO_IS_BIG_ENDIAN
1013/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
1014 uint8_t spare:3, cr:1, alg_id:3, sc:1;
1015#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +02001016} __attribute__((packed));
1017
1018/* Section 9.1.11 */
1019struct gsm48_cm_change {
1020 uint8_t cm2_len;
1021 struct gsm48_classmark2 cm2;
1022 uint8_t data[0];
1023} __attribute__((packed));
1024
1025/* Section 9.1.19 */
1026struct gsm48_imm_ass_ext {
1027 uint8_t l2_plen;
1028 uint8_t proto_discr;
1029 uint8_t msg_type;
1030 uint8_t page_mode;
1031 struct gsm48_chan_desc chan_desc1;
1032 struct gsm48_req_ref req_ref1;
1033 uint8_t timing_advance1;
1034 struct gsm48_chan_desc chan_desc2;
1035 struct gsm48_req_ref req_ref2;
1036 uint8_t timing_advance2;
1037 uint8_t mob_alloc_len;
1038 uint8_t mob_alloc[0];
1039} __attribute__ ((packed));
1040
1041/* Section 9.1.20 */
1042struct gsm48_imm_ass_rej {
1043 uint8_t l2_plen;
1044 uint8_t proto_discr;
1045 uint8_t msg_type;
1046 uint8_t page_mode;
1047 struct gsm48_req_ref req_ref1;
1048 uint8_t wait_ind1;
1049 struct gsm48_req_ref req_ref2;
1050 uint8_t wait_ind2;
1051 struct gsm48_req_ref req_ref3;
1052 uint8_t wait_ind3;
1053 struct gsm48_req_ref req_ref4;
1054 uint8_t wait_ind4;
1055 uint8_t rest[0];
1056} __attribute__ ((packed));
1057
1058/* Section 9.1.22 */
1059struct gsm48_paging1 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001060#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +02001061 uint8_t l2_plen;
1062 uint8_t proto_discr;
1063 uint8_t msg_type;
1064 uint8_t pag_mode:2,
1065 spare:2,
1066 cneed1:2,
1067 cneed2:2;
1068 uint8_t data[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001069#elif OSMO_IS_BIG_ENDIAN
1070/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
1071 uint8_t l2_plen;
1072 uint8_t proto_discr;
1073 uint8_t msg_type;
1074 uint8_t cneed2:2, cneed1:2, spare:2, pag_mode:2;
1075 uint8_t data[0];
1076#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +02001077} __attribute__((packed));
1078
1079/* Section 9.1.23 */
1080struct gsm48_paging2 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001081#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +02001082 uint8_t l2_plen;
1083 uint8_t proto_discr;
1084 uint8_t msg_type;
1085 uint8_t pag_mode:2,
1086 spare:2,
1087 cneed1:2,
1088 cneed2:2;
1089 uint32_t tmsi1;
1090 uint32_t tmsi2;
1091 uint8_t data[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001092#elif OSMO_IS_BIG_ENDIAN
1093/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
1094 uint8_t l2_plen;
1095 uint8_t proto_discr;
1096 uint8_t msg_type;
1097 uint8_t cneed2:2, cneed1:2, spare:2, pag_mode:2;
1098 uint32_t tmsi1;
1099 uint32_t tmsi2;
1100 uint8_t data[0];
1101#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +02001102} __attribute__((packed));
1103
1104/* Section 9.1.24 */
1105struct gsm48_paging3 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001106#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +02001107 uint8_t l2_plen;
1108 uint8_t proto_discr;
1109 uint8_t msg_type;
1110 uint8_t pag_mode:2,
1111 spare:2,
1112 cneed1:2,
1113 cneed2:2;
1114 uint32_t tmsi1;
1115 uint32_t tmsi2;
1116 uint32_t tmsi3;
1117 uint32_t tmsi4;
1118 uint8_t cneed3:2,
1119 cneed4:2,
1120 spare2:4;
1121 uint8_t rest[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001122#elif OSMO_IS_BIG_ENDIAN
1123/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
1124 uint8_t l2_plen;
1125 uint8_t proto_discr;
1126 uint8_t msg_type;
1127 uint8_t cneed2:2, cneed1:2, spare:2, pag_mode:2;
1128 uint32_t tmsi1;
1129 uint32_t tmsi2;
1130 uint32_t tmsi3;
1131 uint32_t tmsi4;
1132 uint8_t spare2:4, cneed4:2, cneed3:2;
1133 uint8_t rest[0];
1134#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +02001135} __attribute__((packed));
1136
1137/* Section 9.1.25 */
1138struct gsm48_pag_rsp {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001139#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +02001140 uint8_t key_seq:3,
1141 spare:5;
1142 uint8_t cm2_len;
1143 struct gsm48_classmark2 cm2;
1144 uint8_t data[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001145#elif OSMO_IS_BIG_ENDIAN
1146/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
1147 uint8_t spare:5, key_seq:3;
1148 uint8_t cm2_len;
1149 struct gsm48_classmark2 cm2;
1150 uint8_t data[0];
1151#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +02001152} __attribute__((packed));
1153
1154/* Section 9.1.29 */
1155struct gsm48_rr_status {
1156 uint8_t rr_cause;
1157} __attribute__((packed));
1158
Harald Welte3f066dd2017-05-29 15:59:03 +02001159/* Section 10.2 + GSM 04.07 12.2.3.1.1 + 3GPP TS 24.007 11.2.3.1.1 */
Harald Welte753ae492019-05-18 11:07:54 +02001160#define GSM48_PDISC_GROUP_CC 0x00
1161#define GSM48_PDISC_BCAST_CC 0x01
1162#define GSM48_PDISC_PDSS1 0x02 /* 04.07 only */
1163#define GSM48_PDISC_CC 0x03
1164#define GSM48_PDISC_PDSS2 0x04 /* 04.07 only */
1165#define GSM48_PDISC_GTTP 0x04 /* 24.007 only */
1166#define GSM48_PDISC_MM 0x05
1167#define GSM48_PDISC_RR 0x06
1168#define GSM48_PDISC_MM_GPRS 0x08
1169#define GSM48_PDISC_SMS 0x09
1170#define GSM48_PDISC_SM_GPRS 0x0a
1171#define GSM48_PDISC_NC_SS 0x0b
1172#define GSM48_PDISC_LOC 0x0c
1173#define GSM48_PDISC_EXTEND 0x0e
1174#define GSM48_PDISC_TEST 0x0f /* as per 11.10, 04.14 */
1175#define GSM48_PDISC_MASK 0x0f
Harald Welteec8b4502010-02-20 20:34:29 +01001176
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +01001177extern const struct value_string gsm48_pdisc_names[];
Harald Welte753ae492019-05-18 11:07:54 +02001178static inline const char *gsm48_pdisc_name(uint8_t val)
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +01001179{ return get_value_string(gsm48_pdisc_names, val); }
1180
Maxfdca25d2016-07-05 16:06:28 +02001181bool gsm48_hdr_gmm_cipherable(const struct gsm48_hdr *hdr);
1182
Harald Welte753ae492019-05-18 11:07:54 +02001183static inline uint8_t gsm48_hdr_pdisc(const struct gsm48_hdr *hdr)
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001184{
1185 /*
1186 * 3GPP TS 24.007 version 12.0.0 Release 12,
1187 * 11.2.3.1.1 Protocol discriminator
1188 */
1189 uint8_t pdisc = hdr->proto_discr & GSM48_PDISC_MASK;
1190 if (pdisc == GSM48_PDISC_EXTEND)
1191 return hdr->proto_discr;
1192 return pdisc;
1193}
1194
Neels Hofmeyrda7bf4d2016-03-14 16:06:48 +01001195static inline uint8_t gsm48_hdr_trans_id(const struct gsm48_hdr *hdr)
1196{
1197 /*
1198 * 3GPP TS 24.007 version 12.0.0 Release 12,
1199 * 11.2.3.1.3 Transaction identifier
1200 */
1201 return (hdr->proto_discr & 0xf0) >> 4;
1202}
1203
Maxda34bf02016-07-17 16:37:56 +02001204#define GSM48_TA_INVALID 220
1205
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001206/*! Check if TA is valid according to 3GPP TS 44.018 ยง 10.5.2.40
Maxedb57e72016-07-14 11:35:17 +02001207 * \param[in] ta Timing Advance value
1208 * \returns true if ta is valid, false otherwise
1209 * Note: Rules for GSM400 band are ignored as it's not implemented in practice.
1210 */
1211static inline bool gsm48_ta_is_valid(uint8_t ta)
1212{
1213 return (ta < 64);
1214}
1215
Neels Hofmeyrda7bf4d2016-03-14 16:06:48 +01001216static inline uint8_t gsm48_hdr_trans_id_flip_ti(const struct gsm48_hdr *hdr)
1217{
1218 return gsm48_hdr_trans_id(hdr) ^ 0x08;
1219}
1220
1221static inline uint8_t gsm48_hdr_trans_id_no_ti(const struct gsm48_hdr *hdr)
1222{
1223 return gsm48_hdr_trans_id(hdr) & 0x07;
1224}
1225
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001226static inline uint8_t gsm48_hdr_msg_type_r98(const struct gsm48_hdr *hdr)
1227{
1228 /*
1229 * 3GPP TS 24.007 version 12.0.0 Release 12,
1230 * 11.2.3.2.1 Message type octet (when accessing Release 98 and older
1231 * networks only)
1232 */
1233 switch (gsm48_hdr_pdisc(hdr)) {
1234 case GSM48_PDISC_MM:
1235 case GSM48_PDISC_CC:
1236 case GSM48_PDISC_NC_SS:
1237 case GSM48_PDISC_GROUP_CC:
1238 case GSM48_PDISC_BCAST_CC:
1239 case GSM48_PDISC_LOC:
Harald Welte143aed72018-02-03 21:14:47 +01001240 return hdr->msg_type & 0x3f;
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001241 default:
1242 return hdr->msg_type;
1243 }
1244}
1245
1246static inline uint8_t gsm48_hdr_msg_type_r99(const struct gsm48_hdr *hdr)
1247{
1248 /*
1249 * 3GPP TS 24.007 version 12.0.0 Release 12,
1250 * 11.2.3.2.2 Message type octet (when accessing Release 99 and newer
1251 * networks)
1252 */
1253 switch (gsm48_hdr_pdisc(hdr)) {
1254 case GSM48_PDISC_MM:
1255 case GSM48_PDISC_CC:
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001256 case GSM48_PDISC_NC_SS:
Harald Weltef1076ed2018-02-03 21:16:45 +01001257 return hdr->msg_type & 0x3f;
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001258 case GSM48_PDISC_GROUP_CC:
1259 case GSM48_PDISC_BCAST_CC:
1260 case GSM48_PDISC_LOC:
Harald Welte143aed72018-02-03 21:14:47 +01001261 return hdr->msg_type & 0x3f;
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001262 default:
1263 return hdr->msg_type;
1264 }
1265}
1266
Maxfe65fa72016-05-10 17:17:05 +02001267void gsm48_set_dtx(struct gsm48_cell_options *op, enum gsm48_dtx_mode full,
1268 enum gsm48_dtx_mode half, bool is_bcch);
1269
Neels Hofmeyrc656fae2016-03-14 16:06:47 +01001270#define gsm48_hdr_msg_type gsm48_hdr_msg_type_r99
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001271
Harald Welteec8b4502010-02-20 20:34:29 +01001272/* Section 10.4 */
1273#define GSM48_MT_RR_INIT_REQ 0x3c
1274#define GSM48_MT_RR_ADD_ASS 0x3b
1275#define GSM48_MT_RR_IMM_ASS 0x3f
1276#define GSM48_MT_RR_IMM_ASS_EXT 0x39
1277#define GSM48_MT_RR_IMM_ASS_REJ 0x3a
Philipp72e43f02016-10-27 13:35:20 +02001278#define GSM48_MT_RR_DTM_ASS_FAIL 0x48
1279#define GSM48_MT_RR_DTM_REJECT 0x49
1280#define GSM48_MT_RR_DTM_REQUEST 0x4A
1281#define GSM48_MT_RR_PACKET_ASS 0x4B
Harald Welteec8b4502010-02-20 20:34:29 +01001282
1283#define GSM48_MT_RR_CIPH_M_CMD 0x35
1284#define GSM48_MT_RR_CIPH_M_COMPL 0x32
1285
1286#define GSM48_MT_RR_CFG_CHG_CMD 0x30
1287#define GSM48_MT_RR_CFG_CHG_ACK 0x31
1288#define GSM48_MT_RR_CFG_CHG_REJ 0x33
1289
1290#define GSM48_MT_RR_ASS_CMD 0x2e
1291#define GSM48_MT_RR_ASS_COMPL 0x29
1292#define GSM48_MT_RR_ASS_FAIL 0x2f
1293#define GSM48_MT_RR_HANDO_CMD 0x2b
1294#define GSM48_MT_RR_HANDO_COMPL 0x2c
1295#define GSM48_MT_RR_HANDO_FAIL 0x28
1296#define GSM48_MT_RR_HANDO_INFO 0x2d
Philipp72e43f02016-10-27 13:35:20 +02001297#define GSM48_MT_RR_HANDO_INFO 0x2d
1298#define GSM48_MT_RR_DTM_ASS_CMD 0x4c
Harald Welteec8b4502010-02-20 20:34:29 +01001299
1300#define GSM48_MT_RR_CELL_CHG_ORDER 0x08
1301#define GSM48_MT_RR_PDCH_ASS_CMD 0x23
1302
1303#define GSM48_MT_RR_CHAN_REL 0x0d
1304#define GSM48_MT_RR_PART_REL 0x0a
1305#define GSM48_MT_RR_PART_REL_COMP 0x0f
1306
1307#define GSM48_MT_RR_PAG_REQ_1 0x21
1308#define GSM48_MT_RR_PAG_REQ_2 0x22
1309#define GSM48_MT_RR_PAG_REQ_3 0x24
1310#define GSM48_MT_RR_PAG_RESP 0x27
1311#define GSM48_MT_RR_NOTIF_NCH 0x20
Philipp72e43f02016-10-27 13:35:20 +02001312#define GSM48_MT_RR_NOTIF_FACCH 0x25 /* (Reserved) */
Harald Welteec8b4502010-02-20 20:34:29 +01001313#define GSM48_MT_RR_NOTIF_RESP 0x26
Philipp72e43f02016-10-27 13:35:20 +02001314#define GSM48_MT_RR_PACKET_NOTIF 0x4e
Philipp349784c2016-10-10 15:03:23 +02001315#define GSM48_MT_RR_UTRAN_CLSM_CHG 0x60
1316#define GSM48_MT_RR_CDMA2K_CLSM_CHG 0x62
1317#define GSM48_MT_RR_IS_TO_UTRAN_HANDO 0x63
1318#define GSM48_MT_RR_IS_TO_CDMA2K_HANDO 0x64
1319
Harald Welteec8b4502010-02-20 20:34:29 +01001320#define GSM48_MT_RR_SYSINFO_8 0x18
1321#define GSM48_MT_RR_SYSINFO_1 0x19
1322#define GSM48_MT_RR_SYSINFO_2 0x1a
1323#define GSM48_MT_RR_SYSINFO_3 0x1b
1324#define GSM48_MT_RR_SYSINFO_4 0x1c
1325#define GSM48_MT_RR_SYSINFO_5 0x1d
1326#define GSM48_MT_RR_SYSINFO_6 0x1e
1327#define GSM48_MT_RR_SYSINFO_7 0x1f
1328
1329#define GSM48_MT_RR_SYSINFO_2bis 0x02
1330#define GSM48_MT_RR_SYSINFO_2ter 0x03
Maxe859aec2016-03-11 12:24:04 +01001331#define GSM48_MT_RR_SYSINFO_2quater 0x07
Harald Welteec8b4502010-02-20 20:34:29 +01001332#define GSM48_MT_RR_SYSINFO_5bis 0x05
1333#define GSM48_MT_RR_SYSINFO_5ter 0x06
1334#define GSM48_MT_RR_SYSINFO_9 0x04
1335#define GSM48_MT_RR_SYSINFO_13 0x00
1336
1337#define GSM48_MT_RR_SYSINFO_16 0x3d
1338#define GSM48_MT_RR_SYSINFO_17 0x3e
1339
Philipp72e43f02016-10-27 13:35:20 +02001340#define GSM48_MT_RR_SYSINFO_18 0x40
1341#define GSM48_MT_RR_SYSINFO_19 0x41
1342#define GSM48_MT_RR_SYSINFO_20 0x42
1343
Harald Welteec8b4502010-02-20 20:34:29 +01001344#define GSM48_MT_RR_CHAN_MODE_MODIF 0x10
1345#define GSM48_MT_RR_STATUS 0x12
1346#define GSM48_MT_RR_CHAN_MODE_MODIF_ACK 0x17
1347#define GSM48_MT_RR_FREQ_REDEF 0x14
1348#define GSM48_MT_RR_MEAS_REP 0x15
1349#define GSM48_MT_RR_CLSM_CHG 0x16
1350#define GSM48_MT_RR_CLSM_ENQ 0x13
1351#define GSM48_MT_RR_EXT_MEAS_REP 0x36
1352#define GSM48_MT_RR_EXT_MEAS_REP_ORD 0x37
1353#define GSM48_MT_RR_GPRS_SUSP_REQ 0x34
Philipp72e43f02016-10-27 13:35:20 +02001354#define GSM48_MT_RR_DTM_INFO 0x4d
Harald Welteec8b4502010-02-20 20:34:29 +01001355
Bhaskare6b45d82013-05-16 17:11:51 +05301356#define GSM48_MT_RR_VGCS_UPL_GRANT 0x09
Harald Welteec8b4502010-02-20 20:34:29 +01001357#define GSM48_MT_RR_UPLINK_RELEASE 0x0e
1358#define GSM48_MT_RR_UPLINK_FREE 0x0c
1359#define GSM48_MT_RR_UPLINK_BUSY 0x2a
1360#define GSM48_MT_RR_TALKER_IND 0x11
1361
1362#define GSM48_MT_RR_APP_INFO 0x38
1363
1364/* Table 10.2/3GPP TS 04.08 */
1365#define GSM48_MT_MM_IMSI_DETACH_IND 0x01
1366#define GSM48_MT_MM_LOC_UPD_ACCEPT 0x02
1367#define GSM48_MT_MM_LOC_UPD_REJECT 0x04
1368#define GSM48_MT_MM_LOC_UPD_REQUEST 0x08
1369
1370#define GSM48_MT_MM_AUTH_REJ 0x11
1371#define GSM48_MT_MM_AUTH_REQ 0x12
1372#define GSM48_MT_MM_AUTH_RESP 0x14
Neels Hofmeyr55a43b82017-02-02 20:27:55 +01001373#define GSM48_MT_MM_AUTH_FAIL 0x1c
Harald Welteec8b4502010-02-20 20:34:29 +01001374#define GSM48_MT_MM_ID_REQ 0x18
1375#define GSM48_MT_MM_ID_RESP 0x19
1376#define GSM48_MT_MM_TMSI_REALL_CMD 0x1a
1377#define GSM48_MT_MM_TMSI_REALL_COMPL 0x1b
1378
1379#define GSM48_MT_MM_CM_SERV_ACC 0x21
1380#define GSM48_MT_MM_CM_SERV_REJ 0x22
1381#define GSM48_MT_MM_CM_SERV_ABORT 0x23
1382#define GSM48_MT_MM_CM_SERV_REQ 0x24
1383#define GSM48_MT_MM_CM_SERV_PROMPT 0x25
1384#define GSM48_MT_MM_CM_REEST_REQ 0x28
1385#define GSM48_MT_MM_ABORT 0x29
1386
1387#define GSM48_MT_MM_NULL 0x30
1388#define GSM48_MT_MM_STATUS 0x31
1389#define GSM48_MT_MM_INFO 0x32
1390
1391/* Table 10.3/3GPP TS 04.08 */
1392#define GSM48_MT_CC_ALERTING 0x01
1393#define GSM48_MT_CC_CALL_CONF 0x08
1394#define GSM48_MT_CC_CALL_PROC 0x02
1395#define GSM48_MT_CC_CONNECT 0x07
1396#define GSM48_MT_CC_CONNECT_ACK 0x0f
1397#define GSM48_MT_CC_EMERG_SETUP 0x0e
1398#define GSM48_MT_CC_PROGRESS 0x03
1399#define GSM48_MT_CC_ESTAB 0x04
1400#define GSM48_MT_CC_ESTAB_CONF 0x06
1401#define GSM48_MT_CC_RECALL 0x0b
1402#define GSM48_MT_CC_START_CC 0x09
1403#define GSM48_MT_CC_SETUP 0x05
1404
1405#define GSM48_MT_CC_MODIFY 0x17
1406#define GSM48_MT_CC_MODIFY_COMPL 0x1f
1407#define GSM48_MT_CC_MODIFY_REJECT 0x13
1408#define GSM48_MT_CC_USER_INFO 0x10
1409#define GSM48_MT_CC_HOLD 0x18
1410#define GSM48_MT_CC_HOLD_ACK 0x19
1411#define GSM48_MT_CC_HOLD_REJ 0x1a
1412#define GSM48_MT_CC_RETR 0x1c
1413#define GSM48_MT_CC_RETR_ACK 0x1d
1414#define GSM48_MT_CC_RETR_REJ 0x1e
1415
1416#define GSM48_MT_CC_DISCONNECT 0x25
1417#define GSM48_MT_CC_RELEASE 0x2d
1418#define GSM48_MT_CC_RELEASE_COMPL 0x2a
1419
1420#define GSM48_MT_CC_CONG_CTRL 0x39
1421#define GSM48_MT_CC_NOTIFY 0x3e
1422#define GSM48_MT_CC_STATUS 0x3d
1423#define GSM48_MT_CC_STATUS_ENQ 0x34
1424#define GSM48_MT_CC_START_DTMF 0x35
1425#define GSM48_MT_CC_STOP_DTMF 0x31
1426#define GSM48_MT_CC_STOP_DTMF_ACK 0x32
1427#define GSM48_MT_CC_START_DTMF_ACK 0x36
1428#define GSM48_MT_CC_START_DTMF_REJ 0x37
1429#define GSM48_MT_CC_FACILITY 0x3a
1430
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001431extern const struct value_string gsm48_rr_msgtype_names[];
1432extern const struct value_string gsm48_mm_msgtype_names[];
1433extern const struct value_string gsm48_cc_msgtype_names[];
1434const char *gsm48_pdisc_msgtype_name(uint8_t pdisc, uint8_t msg_type);
Harald Welte4a62eda2019-03-18 18:27:00 +01001435char *gsm48_pdisc_msgtype_name_buf(char *buf, size_t buf_len, uint8_t pdisc, uint8_t msg_type);
Harald Welte179f3572019-03-18 18:38:47 +01001436char *gsm48_pdisc_msgtype_name_c(const void *ctx, uint8_t pdisc, uint8_t msg_type);
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001437
Harald Welteec8b4502010-02-20 20:34:29 +01001438/* FIXME: Table 10.4 / 10.4a (GPRS) */
1439
Andreas Eversberg014cb872010-07-12 09:11:00 +02001440/* Section 10.5.3.3 CM service type */
Neels Hofmeyrf8963f92019-01-10 23:33:32 +01001441enum osmo_cm_service_type {
1442 GSM48_CMSERV_MO_CALL_PACKET = 1,
1443 GSM48_CMSERV_EMERGENCY = 2,
1444 GSM48_CMSERV_SMS = 4,
1445 GSM48_CMSERV_SUP_SERV = 8,
1446 GSM48_CMSERV_VGCS = 9,
1447 GSM48_CMSERV_VBS = 10,
1448 GSM48_CMSERV_LOC_SERV = 11,
1449 GSM48_CMSERV_MAX_VAL = GSM48_CMSERV_LOC_SERV
1450};
1451
1452extern const struct value_string osmo_cm_service_type_names[];
1453static inline const char *osmo_cm_service_type_name(enum osmo_cm_service_type val)
1454{ return get_value_string(osmo_cm_service_type_names, val); }
Andreas Eversberg014cb872010-07-12 09:11:00 +02001455
Harald Welteec8b4502010-02-20 20:34:29 +01001456/* Section 10.5.2.26, Table 10.5.64 */
1457#define GSM48_PM_MASK 0x03
1458#define GSM48_PM_NORMAL 0x00
1459#define GSM48_PM_EXTENDED 0x01
1460#define GSM48_PM_REORG 0x02
1461#define GSM48_PM_SAME 0x03
1462
1463/* Chapter 10.5.3.5 / Table 10.5.93 */
1464#define GSM48_LUPD_NORMAL 0x0
1465#define GSM48_LUPD_PERIODIC 0x1
1466#define GSM48_LUPD_IMSI_ATT 0x2
1467#define GSM48_LUPD_RESERVED 0x3
1468
Neels Hofmeyr92f3f5e2019-01-05 00:39:13 +01001469extern const struct value_string osmo_lu_type_names[];
1470static inline const char *osmo_lu_type_name(uint8_t lu_type)
1471{ return get_value_string(osmo_lu_type_names, lu_type); }
1472
Harald Welteec8b4502010-02-20 20:34:29 +01001473/* Table 10.5.4 */
1474#define GSM_MI_TYPE_MASK 0x07
1475#define GSM_MI_TYPE_NONE 0x00
1476#define GSM_MI_TYPE_IMSI 0x01
1477#define GSM_MI_TYPE_IMEI 0x02
1478#define GSM_MI_TYPE_IMEISV 0x03
1479#define GSM_MI_TYPE_TMSI 0x04
1480#define GSM_MI_ODD 0x08
1481
Andreas Eversberg014cb872010-07-12 09:11:00 +02001482#define GSM48_IE_MOBILE_ID 0x17 /* 10.5.1.4 */
Harald Welteec8b4502010-02-20 20:34:29 +01001483#define GSM48_IE_NAME_LONG 0x43 /* 10.5.3.5a */
1484#define GSM48_IE_NAME_SHORT 0x45 /* 10.5.3.5a */
1485#define GSM48_IE_UTC 0x46 /* 10.5.3.8 */
1486#define GSM48_IE_NET_TIME_TZ 0x47 /* 10.5.3.9 */
1487#define GSM48_IE_LSA_IDENT 0x48 /* 10.5.3.11 */
Jacob Erlbeck1c3f0882013-09-16 10:29:57 +02001488#define GSM48_IE_NET_DST 0x49 /* 10.5.3.12 [24.008] */
Harald Welteec8b4502010-02-20 20:34:29 +01001489
1490#define GSM48_IE_BEARER_CAP 0x04 /* 10.5.4.5 */
1491#define GSM48_IE_CAUSE 0x08 /* 10.5.4.11 */
1492#define GSM48_IE_CC_CAP 0x15 /* 10.5.4.5a */
1493#define GSM48_IE_ALERT 0x19 /* 10.5.4.26 */
1494#define GSM48_IE_FACILITY 0x1c /* 10.5.4.15 */
1495#define GSM48_IE_PROGR_IND 0x1e /* 10.5.4.21 */
1496#define GSM48_IE_AUX_STATUS 0x24 /* 10.5.4.4 */
1497#define GSM48_IE_NOTIFY 0x27 /* 10.5.4.20 */
1498#define GSM48_IE_KPD_FACILITY 0x2c /* 10.5.4.17 */
1499#define GSM48_IE_SIGNAL 0x34 /* 10.5.4.23 */
1500#define GSM48_IE_CONN_BCD 0x4c /* 10.5.4.13 */
1501#define GSM48_IE_CONN_SUB 0x4d /* 10.5.4.14 */
1502#define GSM48_IE_CALLING_BCD 0x5c /* 10.5.4.9 */
1503#define GSM48_IE_CALLING_SUB 0x5d /* 10.5.4.10 */
1504#define GSM48_IE_CALLED_BCD 0x5e /* 10.5.4.7 */
1505#define GSM48_IE_CALLED_SUB 0x6d /* 10.5.4.8 */
1506#define GSM48_IE_REDIR_BCD 0x74 /* 10.5.4.21a */
1507#define GSM48_IE_REDIR_SUB 0x75 /* 10.5.4.21b */
1508#define GSM48_IE_LOWL_COMPAT 0x7c /* 10.5.4.18 */
1509#define GSM48_IE_HIGHL_COMPAT 0x7d /* 10.5.4.16 */
1510#define GSM48_IE_USER_USER 0x7e /* 10.5.4.25 */
1511#define GSM48_IE_SS_VERS 0x7f /* 10.5.4.24 */
1512#define GSM48_IE_MORE_DATA 0xa0 /* 10.5.4.19 */
1513#define GSM48_IE_CLIR_SUPP 0xa1 /* 10.5.4.11a */
1514#define GSM48_IE_CLIR_INVOC 0xa2 /* 10.5.4.11b */
1515#define GSM48_IE_REV_C_SETUP 0xa3 /* 10.5.4.22a */
1516#define GSM48_IE_REPEAT_CIR 0xd1 /* 10.5.4.22 */
1517#define GSM48_IE_REPEAT_SEQ 0xd3 /* 10.5.4.22 */
1518
1519/* Section 10.5.4.11 / Table 10.5.122 */
1520#define GSM48_CAUSE_CS_GSM 0x60
1521
1522/* Section 9.1.2 / Table 9.3 */
Andreas Eversberg014cb872010-07-12 09:11:00 +02001523/* RR elements */
1524#define GSM48_IE_VGCS_TARGET 0x01
1525//#define GSM48_IE_VGCS_T_MODE_I 0x01
1526#define GSM48_IE_FRQSHORT_AFTER 0x02
1527#define GSM48_IE_MUL_RATE_CFG 0x03 /* 10.5.2.21aa */
1528#define GSM48_IE_FREQ_L_AFTER 0x05
Harald Welteec8b4502010-02-20 20:34:29 +01001529#define GSM48_IE_MSLOT_DESC 0x10
Harald Welteec8b4502010-02-20 20:34:29 +01001530#define GSM48_IE_CHANMODE_2 0x11
Andreas Eversberg014cb872010-07-12 09:11:00 +02001531#define GSM48_IE_FRQSHORT_BEFORE 0x12
1532//#define GSM48_IE_FRQSHORT_BEFOR 0x12
Harald Welteec8b4502010-02-20 20:34:29 +01001533#define GSM48_IE_CHANMODE_3 0x13
1534#define GSM48_IE_CHANMODE_4 0x14
1535#define GSM48_IE_CHANMODE_5 0x15
1536#define GSM48_IE_CHANMODE_6 0x16
1537#define GSM48_IE_CHANMODE_7 0x17
1538#define GSM48_IE_CHANMODE_8 0x18
1539#define GSM48_IE_CHANDESC_2 0x64
Harald Welte639f74b2010-06-15 09:32:14 +02001540#define GSM48_IE_MA_AFTER 0x72
1541#define GSM48_IE_START_TIME 0x7c
1542#define GSM48_IE_FREQ_L_BEFORE 0x19
Andreas Eversberg014cb872010-07-12 09:11:00 +02001543//#define GSM48_IE_FRQLIST_BEFORE 0x19
Harald Welte639f74b2010-06-15 09:32:14 +02001544#define GSM48_IE_CH_DESC_1_BEFORE 0x1c
Andreas Eversberg014cb872010-07-12 09:11:00 +02001545//#define GSM48_IE_CHDES_1_BEFORE 0x1c
Harald Welte639f74b2010-06-15 09:32:14 +02001546#define GSM48_IE_CH_DESC_2_BEFORE 0x1d
Andreas Eversberg014cb872010-07-12 09:11:00 +02001547//#define GSM48_IE_CHDES_2_BEFORE 0x1d
Harald Welte639f74b2010-06-15 09:32:14 +02001548#define GSM48_IE_F_CH_SEQ_BEFORE 0x1e
Andreas Eversberg014cb872010-07-12 09:11:00 +02001549//#define GSM48_IE_FRQSEQ_BEFORE 0x1e
1550#define GSM48_IE_CLASSMARK3 0x20
Harald Welte639f74b2010-06-15 09:32:14 +02001551#define GSM48_IE_MA_BEFORE 0x21
Andreas Eversberg014cb872010-07-12 09:11:00 +02001552#define GSM48_IE_RR_PACKET_UL 0x22
1553#define GSM48_IE_RR_PACKET_DL 0x23
1554#define GSM48_IE_CELL_CH_DESC 0x62
1555#define GSM48_IE_CHANMODE_1 0x63
1556#define GSM48_IE_CHDES_2_AFTER 0x64
1557#define GSM48_IE_MODE_SEC_CH 0x66
1558#define GSM48_IE_F_CH_SEQ_AFTER 0x69
1559#define GSM48_IE_MA_AFTER 0x72
1560#define GSM48_IE_BA_RANGE 0x73
1561#define GSM48_IE_GROUP_CHDES 0x74
1562#define GSM48_IE_BA_LIST_PREF 0x75
1563#define GSM48_IE_MOB_OVSERV_DIF 0x77
Harald Weltecf2caeb2019-02-03 00:37:20 +01001564#define GSM48_IE_CELL_SEL_IND_AFTER_REL 0x77 /* 44.018 Section 9.1.7 */
Andreas Eversberg014cb872010-07-12 09:11:00 +02001565#define GSM48_IE_REALTIME_DIFF 0x7b
1566#define GSM48_IE_START_TIME 0x7c
Harald Weltecf2caeb2019-02-03 00:37:20 +01001567#define GSM48_IE_INDIVIDUAL_PRIORITIES 0x7c /* 44.018 Section 9.1.7 */
Andreas Eversberg014cb872010-07-12 09:11:00 +02001568#define GSM48_IE_TIMING_ADVANCE 0x7d
1569#define GSM48_IE_GROUP_CIP_SEQ 0x80
1570#define GSM48_IE_CIP_MODE_SET 0x90
1571#define GSM48_IE_GPRS_RESUMPT 0xc0
1572#define GSM48_IE_SYNC_IND 0xd0
1573/* System Information 4 (types are equal IEs above) */
1574#define GSM48_IE_CBCH_CHAN_DESC 0x64
1575#define GSM48_IE_CBCH_MOB_AL 0x72
Harald Welte639f74b2010-06-15 09:32:14 +02001576
Andreas Eversberg014cb872010-07-12 09:11:00 +02001577/* Additional MM elements */
1578#define GSM48_IE_LOCATION_AREA 0x13
Harald Welte82f94ef2016-05-05 23:33:27 +02001579#define GSM48_IE_AUTN 0x20
Neels Hofmeyr55a43b82017-02-02 20:27:55 +01001580#define GSM48_IE_AUTH_RES_EXT 0x21
1581#define GSM48_IE_AUTS 0x22
Andreas Eversberg014cb872010-07-12 09:11:00 +02001582#define GSM48_IE_PRIORITY_LEV 0x80
1583#define GSM48_IE_FOLLOW_ON_PROC 0xa1
1584#define GSM48_IE_CTS_PERMISSION 0xa2
Harald Welteec8b4502010-02-20 20:34:29 +01001585
Keith05d32782018-05-28 14:08:10 +02001586/* Section 10.5.4.21 / Table 10.5.127 */
1587
1588enum gsm48_progress_desc {
1589 GSM48_PROGR_NOT_E2E = 0x00,
1590 GSM48_PROGR_DEST_NOT_PLMN = 0x02,
1591 GSM48_PROGR_ORIG_NOT_PLMN = 0x03,
1592 GSM48_PROGR_RETURNED = 0x04,
1593 GSM48_PROGR_IN_BAND_AVAIL = 0x08,
1594 GSM48_PROGR_CALL_E2E = 0x20,
1595 GSM48_PROGR_QUEUEING = 0x40,
1596};
1597
Harald Welteec8b4502010-02-20 20:34:29 +01001598/* Section 10.5.4.23 / Table 10.5.130 */
1599enum gsm48_signal_val {
1600 GSM48_SIGNAL_DIALTONE = 0x00,
1601 GSM48_SIGNAL_RINGBACK = 0x01,
1602 GSM48_SIGNAL_INTERCEPT = 0x02,
1603 GSM48_SIGNAL_NET_CONG = 0x03,
1604 GSM48_SIGNAL_BUSY = 0x04,
1605 GSM48_SIGNAL_CONFIRM = 0x05,
1606 GSM48_SIGNAL_ANSWER = 0x06,
1607 GSM48_SIGNAL_CALL_WAIT = 0x07,
1608 GSM48_SIGNAL_OFF_HOOK = 0x08,
1609 GSM48_SIGNAL_OFF = 0x3f,
1610 GSM48_SIGNAL_ALERT_OFF = 0x4f,
1611};
1612
Keithadfa1992018-05-25 15:24:06 +02001613/* Section 10.5.4.11 / Table 10.5.122 */
1614enum gsm48_cause_coding {
1615 GSM48_CAUSE_CODING_CCITT_Q931 = 0x00,
1616 GSM48_CAUSE_CODING_RESERVED = 0x01,
1617 GSM48_CAUSE_CODING_NATIONAL = 0x02,
1618 GSM48_CAUSE_CODING_GSM = 0x03,
1619};
1620
Harald Welteec8b4502010-02-20 20:34:29 +01001621enum gsm48_cause_loc {
1622 GSM48_CAUSE_LOC_USER = 0x00,
1623 GSM48_CAUSE_LOC_PRN_S_LU = 0x01,
1624 GSM48_CAUSE_LOC_PUN_S_LU = 0x02,
1625 GSM48_CAUSE_LOC_TRANS_NET = 0x03,
1626 GSM48_CAUSE_LOC_PUN_S_RU = 0x04,
1627 GSM48_CAUSE_LOC_PRN_S_RU = 0x05,
1628 /* not defined */
1629 GSM48_CAUSE_LOC_INN_NET = 0x07,
1630 GSM48_CAUSE_LOC_NET_BEYOND = 0x0a,
1631};
1632
Neels Hofmeyr6ad50aa2019-01-14 20:28:56 +01001633/* 3GPP TS 44.018 10.5.2.31 RR Cause / Table 10.5.70 */
Harald Welteec8b4502010-02-20 20:34:29 +01001634enum gsm48_rr_cause {
1635 GSM48_RR_CAUSE_NORMAL = 0x00,
1636 GSM48_RR_CAUSE_ABNORMAL_UNSPEC = 0x01,
1637 GSM48_RR_CAUSE_ABNORMAL_UNACCT = 0x02,
1638 GSM48_RR_CAUSE_ABNORMAL_TIMER = 0x03,
1639 GSM48_RR_CAUSE_ABNORMAL_NOACT = 0x04,
1640 GSM48_RR_CAUSE_PREMPTIVE_REL = 0x05,
Andreas Eversbergc8cac642013-06-19 20:58:59 +02001641 GSM48_RR_CAUSE_HNDOVER_IMP = 0x08,
1642 GSM48_RR_CAUSE_CHAN_MODE_UNACCT = 0x09,
1643 GSM48_RR_CAUSE_FREQ_NOT_IMPL = 0x0a,
Harald Welteec8b4502010-02-20 20:34:29 +01001644 GSM48_RR_CAUSE_CALL_CLEARED = 0x41,
1645 GSM48_RR_CAUSE_SEMANT_INCORR = 0x5f,
1646 GSM48_RR_CAUSE_INVALID_MAND_INF = 0x60,
1647 GSM48_RR_CAUSE_MSG_TYPE_N = 0x61,
1648 GSM48_RR_CAUSE_MSG_TYPE_N_COMPAT= 0x62,
1649 GSM48_RR_CAUSE_COND_IE_ERROR = 0x64,
1650 GSM48_RR_CAUSE_NO_CELL_ALLOC_A = 0x65,
1651 GSM48_RR_CAUSE_PROT_ERROR_UNSPC = 0x6f,
1652};
1653
1654/* Section 10.5.4.11 CC Cause / Table 10.5.123 */
1655enum gsm48_cc_cause {
1656 GSM48_CC_CAUSE_UNASSIGNED_NR = 1,
1657 GSM48_CC_CAUSE_NO_ROUTE = 3,
1658 GSM48_CC_CAUSE_CHAN_UNACCEPT = 6,
1659 GSM48_CC_CAUSE_OP_DET_BARRING = 8,
1660 GSM48_CC_CAUSE_NORM_CALL_CLEAR = 16,
1661 GSM48_CC_CAUSE_USER_BUSY = 17,
1662 GSM48_CC_CAUSE_USER_NOTRESPOND = 18,
1663 GSM48_CC_CAUSE_USER_ALERTING_NA = 19,
1664 GSM48_CC_CAUSE_CALL_REJECTED = 21,
1665 GSM48_CC_CAUSE_NUMBER_CHANGED = 22,
1666 GSM48_CC_CAUSE_PRE_EMPTION = 25,
1667 GSM48_CC_CAUSE_NONSE_USER_CLR = 26,
1668 GSM48_CC_CAUSE_DEST_OOO = 27,
1669 GSM48_CC_CAUSE_INV_NR_FORMAT = 28,
1670 GSM48_CC_CAUSE_FACILITY_REJ = 29,
1671 GSM48_CC_CAUSE_RESP_STATUS_INQ = 30,
1672 GSM48_CC_CAUSE_NORMAL_UNSPEC = 31,
1673 GSM48_CC_CAUSE_NO_CIRCUIT_CHAN = 34,
1674 GSM48_CC_CAUSE_NETWORK_OOO = 38,
1675 GSM48_CC_CAUSE_TEMP_FAILURE = 41,
1676 GSM48_CC_CAUSE_SWITCH_CONG = 42,
1677 GSM48_CC_CAUSE_ACC_INF_DISCARD = 43,
1678 GSM48_CC_CAUSE_REQ_CHAN_UNAVAIL = 44,
1679 GSM48_CC_CAUSE_RESOURCE_UNAVAIL = 47,
1680 GSM48_CC_CAUSE_QOS_UNAVAIL = 49,
1681 GSM48_CC_CAUSE_REQ_FAC_NOT_SUBSC= 50,
1682 GSM48_CC_CAUSE_INC_BARRED_CUG = 55,
1683 GSM48_CC_CAUSE_BEARER_CAP_UNAUTH= 57,
1684 GSM48_CC_CAUSE_BEARER_CA_UNAVAIL= 58,
1685 GSM48_CC_CAUSE_SERV_OPT_UNAVAIL = 63,
1686 GSM48_CC_CAUSE_BEARERSERV_UNIMPL= 65,
1687 GSM48_CC_CAUSE_ACM_GE_ACM_MAX = 68,
1688 GSM48_CC_CAUSE_REQ_FAC_NOTIMPL = 69,
1689 GSM48_CC_CAUSE_RESTR_BCAP_AVAIL = 70,
1690 GSM48_CC_CAUSE_SERV_OPT_UNIMPL = 79,
1691 GSM48_CC_CAUSE_INVAL_TRANS_ID = 81,
1692 GSM48_CC_CAUSE_USER_NOT_IN_CUG = 87,
1693 GSM48_CC_CAUSE_INCOMPAT_DEST = 88,
1694 GSM48_CC_CAUSE_INVAL_TRANS_NET = 91,
1695 GSM48_CC_CAUSE_SEMANTIC_INCORR = 95,
1696 GSM48_CC_CAUSE_INVAL_MAND_INF = 96,
1697 GSM48_CC_CAUSE_MSGTYPE_NOTEXIST = 97,
1698 GSM48_CC_CAUSE_MSGTYPE_INCOMPAT = 98,
1699 GSM48_CC_CAUSE_IE_NOTEXIST = 99,
1700 GSM48_CC_CAUSE_COND_IE_ERR = 100,
1701 GSM48_CC_CAUSE_MSG_INCOMP_STATE = 101,
1702 GSM48_CC_CAUSE_RECOVERY_TIMER = 102,
1703 GSM48_CC_CAUSE_PROTO_ERR = 111,
1704 GSM48_CC_CAUSE_INTERWORKING = 127,
1705};
1706
Keith3cdaa8d2018-08-31 20:09:18 +02001707extern const struct value_string gsm48_cc_cause_names[];
1708static inline const char *gsm48_cc_cause_name(enum gsm48_cc_cause val)
1709{ return get_value_string(gsm48_cc_cause_names, val); }
1710
Harald Welteec8b4502010-02-20 20:34:29 +01001711/* Annex G, GSM specific cause values for mobility management */
1712enum gsm48_reject_value {
1713 GSM48_REJECT_IMSI_UNKNOWN_IN_HLR = 2,
1714 GSM48_REJECT_ILLEGAL_MS = 3,
1715 GSM48_REJECT_IMSI_UNKNOWN_IN_VLR = 4,
1716 GSM48_REJECT_IMEI_NOT_ACCEPTED = 5,
1717 GSM48_REJECT_ILLEGAL_ME = 6,
1718 GSM48_REJECT_PLMN_NOT_ALLOWED = 11,
1719 GSM48_REJECT_LOC_NOT_ALLOWED = 12,
1720 GSM48_REJECT_ROAMING_NOT_ALLOWED = 13,
1721 GSM48_REJECT_NETWORK_FAILURE = 17,
Neels Hofmeyr55a43b82017-02-02 20:27:55 +01001722 GSM48_REJECT_SYNCH_FAILURE = 21,
Harald Welteec8b4502010-02-20 20:34:29 +01001723 GSM48_REJECT_CONGESTION = 22,
1724 GSM48_REJECT_SRV_OPT_NOT_SUPPORTED = 32,
1725 GSM48_REJECT_RQD_SRV_OPT_NOT_SUPPORTED = 33,
1726 GSM48_REJECT_SRV_OPT_TMP_OUT_OF_ORDER = 34,
1727 GSM48_REJECT_CALL_CAN_NOT_BE_IDENTIFIED = 38,
1728 GSM48_REJECT_INCORRECT_MESSAGE = 95,
1729 GSM48_REJECT_INVALID_MANDANTORY_INF = 96,
1730 GSM48_REJECT_MSG_TYPE_NOT_IMPLEMENTED = 97,
1731 GSM48_REJECT_MSG_TYPE_NOT_COMPATIBLE = 98,
1732 GSM48_REJECT_INF_ELEME_NOT_IMPLEMENTED = 99,
1733 GSM48_REJECT_CONDTIONAL_IE_ERROR = 100,
1734 GSM48_REJECT_MSG_NOT_COMPATIBLE = 101,
1735 GSM48_REJECT_PROTOCOL_ERROR = 111,
1736
1737 /* according to G.6 Additional cause codes for GMM */
1738 GSM48_REJECT_GPRS_NOT_ALLOWED = 7,
1739 GSM48_REJECT_SERVICES_NOT_ALLOWED = 8,
1740 GSM48_REJECT_MS_IDENTITY_NOT_DERVIVABLE = 9,
1741 GSM48_REJECT_IMPLICITLY_DETACHED = 10,
1742 GSM48_REJECT_GPRS_NOT_ALLOWED_IN_PLMN = 14,
1743 GSM48_REJECT_MSC_TMP_NOT_REACHABLE = 16,
1744};
1745
Neels Hofmeyraead2412018-04-06 04:31:00 +02001746extern const struct value_string gsm48_reject_value_names[];
1747static inline const char *gsm48_reject_value_name(enum gsm48_reject_value val)
1748{ return get_value_string(gsm48_reject_value_names, val); }
1749
Harald Welteec8b4502010-02-20 20:34:29 +01001750enum chreq_type {
1751 CHREQ_T_EMERG_CALL,
1752 CHREQ_T_CALL_REEST_TCH_F,
1753 CHREQ_T_CALL_REEST_TCH_H,
1754 CHREQ_T_CALL_REEST_TCH_H_DBL,
1755 CHREQ_T_SDCCH,
1756 CHREQ_T_TCH_F,
1757 CHREQ_T_VOICE_CALL_TCH_H,
1758 CHREQ_T_DATA_CALL_TCH_H,
1759 CHREQ_T_LOCATION_UPD,
1760 CHREQ_T_PAG_R_ANY_NECI0,
1761 CHREQ_T_PAG_R_ANY_NECI1,
1762 CHREQ_T_PAG_R_TCH_F,
1763 CHREQ_T_PAG_R_TCH_FH,
1764 CHREQ_T_LMU,
1765 CHREQ_T_RESERVED_SDCCH,
1766 CHREQ_T_RESERVED_IGNORE,
Alexander Couzensf48e8a82016-12-05 15:57:42 +01001767 CHREQ_T_PDCH_ONE_PHASE,
1768 CHREQ_T_PDCH_TWO_PHASE,
Alexander Couzens953f9292017-03-14 13:47:29 +01001769 _NUM_CHREQ_T,
Harald Welteec8b4502010-02-20 20:34:29 +01001770};
1771
1772/* Chapter 11.3 */
1773#define GSM48_T301 180, 0
1774#define GSM48_T303 30, 0
1775#define GSM48_T305 30, 0
1776#define GSM48_T306 30, 0
Harald Weltee50b0092018-01-27 09:40:34 +01001777#define GSM48_T308 10, 0 /* no spec default */
Harald Weltecd827102018-01-27 09:43:03 +01001778#define GSM48_T310 30, 0 /* no spec default */
Harald Weltee50b0092018-01-27 09:40:34 +01001779#define GSM48_T313 30, 0 /* no spec default */
Harald Welteec8b4502010-02-20 20:34:29 +01001780#define GSM48_T323 30, 0
Harald Weltee50b0092018-01-27 09:40:34 +01001781#define GSM48_T331 30, 0 /* no spec default */
1782#define GSM48_T333 30, 0 /* no spec default */
1783#define GSM48_T334 25, 0 /* min 15s */
1784#define GSM48_T338 30, 0 /* no spec default */
Andreas Eversberg014cb872010-07-12 09:11:00 +02001785#define GSM48_T303_MS 30, 0
1786#define GSM48_T305_MS 30, 0
1787#define GSM48_T308_MS 30, 0
1788#define GSM48_T310_MS 30, 0
1789#define GSM48_T313_MS 30, 0
1790#define GSM48_T323_MS 30, 0
1791#define GSM48_T332_MS 30, 0
1792#define GSM48_T335_MS 30, 0
Harald Welteec8b4502010-02-20 20:34:29 +01001793
1794/* Chapter 5.1.2.2 */
1795#define GSM_CSTATE_NULL 0
1796#define GSM_CSTATE_INITIATED 1
Andreas Eversberg1ef041f2010-04-09 07:52:12 +02001797#define GSM_CSTATE_MM_CONNECTION_PEND 2 /* see 10.5.4.6 */
Harald Welteec8b4502010-02-20 20:34:29 +01001798#define GSM_CSTATE_MO_CALL_PROC 3
1799#define GSM_CSTATE_CALL_DELIVERED 4
1800#define GSM_CSTATE_CALL_PRESENT 6
1801#define GSM_CSTATE_CALL_RECEIVED 7
1802#define GSM_CSTATE_CONNECT_REQUEST 8
1803#define GSM_CSTATE_MO_TERM_CALL_CONF 9
1804#define GSM_CSTATE_ACTIVE 10
1805#define GSM_CSTATE_DISCONNECT_REQ 12
1806#define GSM_CSTATE_DISCONNECT_IND 12
1807#define GSM_CSTATE_RELEASE_REQ 19
1808#define GSM_CSTATE_MO_ORIG_MODIFY 26
1809#define GSM_CSTATE_MO_TERM_MODIFY 27
1810#define GSM_CSTATE_CONNECT_IND 28
1811
1812#define SBIT(a) (1 << a)
1813#define ALL_STATES 0xffffffff
1814
1815/* Table 10.5.3/3GPP TS 04.08: Location Area Identification information element */
1816#define GSM_LAC_RESERVED_DETACHED 0x0
1817#define GSM_LAC_RESERVED_ALL_BTS 0xfffe
1818
1819/* GSM 04.08 Bearer Capability: Information Transfer Capability */
1820enum gsm48_bcap_itcap {
1821 GSM48_BCAP_ITCAP_SPEECH = 0,
1822 GSM48_BCAP_ITCAP_UNR_DIG_INF = 1,
1823 GSM48_BCAP_ITCAP_3k1_AUDIO = 2,
1824 GSM48_BCAP_ITCAP_FAX_G3 = 3,
1825 GSM48_BCAP_ITCAP_OTHER = 5,
1826 GSM48_BCAP_ITCAP_RESERVED = 7,
1827};
1828
1829/* GSM 04.08 Bearer Capability: Transfer Mode */
1830enum gsm48_bcap_tmod {
1831 GSM48_BCAP_TMOD_CIRCUIT = 0,
1832 GSM48_BCAP_TMOD_PACKET = 1,
1833};
1834
1835/* GSM 04.08 Bearer Capability: Coding Standard */
1836enum gsm48_bcap_coding {
1837 GSM48_BCAP_CODING_GSM_STD = 0,
1838};
1839
1840/* GSM 04.08 Bearer Capability: Radio Channel Requirements */
1841enum gsm48_bcap_rrq {
1842 GSM48_BCAP_RRQ_FR_ONLY = 1,
1843 GSM48_BCAP_RRQ_DUAL_HR = 2,
1844 GSM48_BCAP_RRQ_DUAL_FR = 3,
1845};
1846
Harald Weltec8a0b932012-08-24 21:27:26 +02001847/* GSM 04.08 Bearer Capability: Rate Adaption */
1848enum gsm48_bcap_ra {
1849 GSM48_BCAP_RA_NONE = 0,
1850 GSM48_BCAP_RA_V110_X30 = 1,
1851 GSM48_BCAP_RA_X31 = 2,
1852 GSM48_BCAP_RA_OTHER = 3,
1853};
1854
1855/* GSM 04.08 Bearer Capability: Signalling access protocol */
1856enum gsm48_bcap_sig_access {
1857 GSM48_BCAP_SA_I440_I450 = 1,
1858 GSM48_BCAP_SA_X21 = 2,
1859 GSM48_BCAP_SA_X28_DP_IN = 3,
1860 GSM48_BCAP_SA_X28_DP_UN = 4,
1861 GSM48_BCAP_SA_X28_NDP = 5,
1862 GSM48_BCAP_SA_X32 = 6,
1863};
1864
1865/* GSM 04.08 Bearer Capability: User Rate */
1866enum gsm48_bcap_user_rate {
1867 GSM48_BCAP_UR_300 = 1,
1868 GSM48_BCAP_UR_1200 = 2,
1869 GSM48_BCAP_UR_2400 = 3,
1870 GSM48_BCAP_UR_4800 = 4,
1871 GSM48_BCAP_UR_9600 = 5,
1872 GSM48_BCAP_UR_12000 = 6,
1873 GSM48_BCAP_UR_1200_75 = 7,
1874};
1875
1876/* GSM 04.08 Bearer Capability: Parity */
1877enum gsm48_bcap_parity {
1878 GSM48_BCAP_PAR_ODD = 0,
1879 GSM48_BCAP_PAR_EVEN = 2,
1880 GSM48_BCAP_PAR_NONE = 3,
1881 GSM48_BCAP_PAR_ZERO = 4,
1882 GSM48_BCAP_PAR_ONE = 5,
1883};
1884
1885/* GSM 04.08 Bearer Capability: Intermediate Rate */
1886enum gsm48_bcap_interm_rate {
1887 GSM48_BCAP_IR_8k = 2,
1888 GSM48_BCAP_IR_16k = 3,
1889};
1890
1891/* GSM 04.08 Bearer Capability: Transparency */
1892enum gsm48_bcap_transp {
1893 GSM48_BCAP_TR_TRANSP = 0,
1894 GSM48_BCAP_TR_RLP = 1,
1895 GSM48_BCAP_TR_TR_PREF = 2,
1896 GSM48_BCAP_TR_RLP_PREF = 3,
1897};
1898
1899/* GSM 04.08 Bearer Capability: Modem Type */
1900enum gsm48_bcap_modem_type {
1901 GSM48_BCAP_MT_NONE = 0,
1902 GSM48_BCAP_MT_V21 = 1,
1903 GSM48_BCAP_MT_V22 = 2,
1904 GSM48_BCAP_MT_V22bis = 3,
1905 GSM48_BCAP_MT_V23 = 4,
1906 GSM48_BCAP_MT_V26ter = 5,
1907 GSM48_BCAP_MT_V32 = 6,
1908 GSM48_BCAP_MT_UNDEF = 7,
1909 GSM48_BCAP_MT_AUTO_1 = 8,
1910};
1911
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001912/*! GSM 04.08 Bearer Capability: Speech Version Indication
Philipp Maier3d9191e2017-05-31 17:22:03 +02001913 * (See also 3GPP TS 24.008, Table 10.5.103) */
Harald Welte30a8ec42012-08-24 23:00:05 +02001914enum gsm48_bcap_speech_ver {
Philipp Maiera9e193b2017-06-16 16:47:06 +02001915 GSM48_BCAP_SV_FR = 0, /*!< GSM FR V1 (GSM FR) */
1916 GSM48_BCAP_SV_HR = 1, /*!< GSM HR V1 (GSM HR) */
1917 GSM48_BCAP_SV_EFR = 2, /*!< GSM FR V2 (GSM EFR) */
1918 GSM48_BCAP_SV_AMR_F = 4, /*!< GSM FR V3 (FR AMR) */
1919 GSM48_BCAP_SV_AMR_H = 5, /*!< GSM HR V3 (HR_AMR) */
Philipp Maier3d9191e2017-05-31 17:22:03 +02001920 GSM48_BCAP_SV_AMR_OFW = 6, /*!< GSM FR V4 (OFR AMR-WB) */
1921 GSM48_BCAP_SV_AMR_OHW = 7, /*!< GSM HR V4 (OHR AMR-WB) */
1922 GSM48_BCAP_SV_AMR_FW = 8, /*!< GSM FR V5 (FR AMR-WB) */
1923 GSM48_BCAP_SV_AMR_OH = 11, /*!< GSM HR V6 (OHR AMR) */
Harald Welte30a8ec42012-08-24 23:00:05 +02001924};
1925
Harald Welteec8b4502010-02-20 20:34:29 +01001926#define GSM48_TMSI_LEN 5
1927#define GSM48_MID_TMSI_LEN (GSM48_TMSI_LEN + 2)
1928#define GSM48_MI_SIZE 32
1929
Maxff2eeda2018-01-04 18:43:44 +01001930/* 3GPP TS 24.008 ยง 10.5.5.15 Routing area identification */
Harald Weltea1c4f762010-05-01 11:59:42 +02001931struct gsm48_ra_id {
1932 uint8_t digits[3]; /* MCC + MNC BCD digits */
1933 uint16_t lac; /* Location Area Code */
1934 uint8_t rac; /* Routing Area Code */
1935} __attribute__ ((packed));
1936
Harald Welteb5503132011-05-24 15:01:53 +02001937#define GSM48_CELL_CHAN_DESC_SIZE 16
Harald Weltea1c4f762010-05-01 11:59:42 +02001938
Harald Welteb5503132011-05-24 15:01:53 +02001939#define GSM_MACBLOCK_LEN 23
1940#define GSM_MACBLOCK_PADDING 0x2b
Harald Welte55478082018-02-09 22:39:29 +01001941
1942/* Table 10.5.118 / 3GPP TS 24.008 Section 10.5.4.7 */
1943enum gsm48_type_of_number {
1944 GSM48_TON_UNKNOWN = 0,
1945 GSM48_TON_INTERNATIONAL = 1,
1946 GSM48_TON_NATIONAL = 2,
1947 GSM48_TON_NET_SPEC = 3,
1948 GSM48_TON_SHORT_CODE = 4,
1949 /* reserved */
1950};
1951
1952/* Table 10.5.118 / 3GPP TS 24.008 Section 10.5.4.7 */
1953enum gsm48_numbering_plan {
1954 GSM48_NPI_UNKNOWN = 0,
1955 GSM48_NPI_ISDN_E164 = 1,
1956 GSM48_NPI_DATA_X121 = 3,
1957 GSM48_NPI_TELEX_F69 = 4,
1958 GSM48_NPI_NATIONAL = 8,
1959 GSM48_NPI_PRIVATE = 9,
1960 GSM48_NPI_CTS = 11,
1961 /* reserved */
1962};