blob: 5b8dd515b97a84bcaf1a961f63cc80f582df33db [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
Oliver Smith0b5c09b2023-02-17 10:35:38 +010025/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +010026 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
Oliver Smith0b5c09b2023-02-17 10:35:38 +010054/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +010055 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
Philipp Maiere36be562020-11-12 11:33:54 +010061/* Chapter 10.5.1.7 */
62struct gsm48_classmark3 {
63 uint8_t a5_bits;
64 uint8_t mult_band_supp;
65 uint8_t assoc_radio_cap_1;
66 uint8_t assoc_radio_cap_2;
67
68 struct {
69 bool present;
70 uint8_t r_gsm_assoc_radio_cap;
71 } r_support;
72
73 struct {
74 bool present;
75 uint8_t mslot_class;
76 } hscsd_mult_slot_cap;
77
78 bool ucs2_treatment;
79 bool extended_meas_cap;
80
81 struct {
82 bool present;
83 uint8_t sms_value;
84 uint8_t sm_value;
85 } ms_meas_cap;
86
87 struct {
88 bool present;
89 uint8_t method;
90 } ms_pos_method_cap;
91
92 struct {
93 bool present;
94 uint8_t mslot_class;
95 } ecsd_multislot_cap;
96
97 struct {
98 bool present;
99 bool mod_cap;
100
101 struct {
102 bool present;
103 uint8_t value;
104 } rf_pwr_cap_1;
105
106 struct {
107 bool present;
108 uint8_t value;
109 } rf_pwr_cap_2;
110
111 } psk8_struct;
112
113 struct {
114 bool present;
115 uint8_t value;
116 uint8_t assoc_radio_cap;
117 } gsm_400_bands_supp;
118
119 struct {
120 bool present;
121 uint8_t value;
122 } gsm_850_assoc_radio_cap;
123
124 struct {
125 bool present;
126 uint8_t value;
127 } gsm_1900_assoc_radio_cap;
128
129 bool umts_fdd_rat_cap;
130 bool umts_tdd_rat_cap;
131 bool cdma200_rat_cap;
132
133 struct {
134 bool present;
135 uint8_t mslot_class;
136 bool single_slot_dtm;
137 struct {
138 bool present;
139 uint8_t mslot_class;
140 } dtm_egprs_multislot_cap;
141 } dtm_gprs_multislot_cap;
142
143 struct {
144 bool present;
145 uint8_t value;
146 } single_band_supp;
147
148 struct {
149 bool present;
150 uint8_t value;
151 } gsm_750_assoc_radio_cap;
152
153 bool umts_1_28_mcps_tdd_rat_cap;
154 bool geran_feature_package;
155
156 struct {
157 bool present;
158 uint8_t mslot_class;
159 struct {
160 bool present;
161 uint8_t mslot_class;
162 } extended_dtm_egprs_multislot_cap;
163 } extended_dtm_gprs_multislot_cap;
164
165 struct {
166 bool present;
167 uint8_t value;
168 } high_multislot_cap;
169
170 bool geran_feature_package_2;
171 uint8_t gmsk_multislot_power_prof;
172 uint8_t psk8_multislot_power_prof;
173
174 struct {
175 bool present;
176 uint8_t value;
177 uint8_t assoc_radio_cap;
178 } t_gsm_400_bands_supp;
179
180 uint8_t dl_advanced_rx_perf;
181 bool dtm_enhancements_cap;
182
183 struct {
184 bool present;
185 uint8_t mslot_class;
186 bool offset_required;
187 struct {
188 bool present;
189 uint8_t mslot_class;
190 } dtm_egprs_high_multislot_cap;
191 } dtm_gprs_high_multislot_cap;
192
193 bool repeated_acch_capability;
194
195 struct {
196 bool present;
197 uint8_t value;
198 } gsm_710_assoc_radio_cap;
199
200 struct {
201 bool present;
202 uint8_t value;
203 } t_gsm_810_assoc_radio_cap;
204
205 bool ciphering_mode_setting_cap;
206 bool add_pos_cap;
207 bool e_utra_fdd_supp;
208 bool e_utra_tdd_supp;
209 bool e_utra_meas_rep_supp;
210 bool prio_resel_supp;
211 bool utra_csg_cells_rep;
212
213 uint8_t vamos_level;
214 uint8_t tighter_capability;
215
216 bool sel_ciph_dl_sacch;
217
218 uint8_t cs_ps_srvcc_geran_utra;
219 uint8_t cs_ps_srvcc_geran_eutra;
220
221 bool geran_net_sharing;
222 bool e_utra_wb_rsrq_meas_supp;
223 bool er_band_support;
224 bool utra_mult_band_ind_supp;
225 bool e_utra_mult_band_ind_supp;
226 bool extended_tsc_set_cap_supp;
227 bool extended_earfcn_val_range;
228};
229
Neels Hofmeyr7740d262019-01-16 16:53:26 +0100230struct osmo_gsm48_classmark {
231 bool classmark1_set;
232 struct gsm48_classmark1 classmark1;
233 uint8_t classmark2_len;
234 struct gsm48_classmark2 classmark2;
235 uint8_t classmark3_len;
236 uint8_t classmark3[14]; /* if cm3 gets extended by spec, it will be truncated */
237};
238
239bool osmo_gsm48_classmark_is_r99(const struct osmo_gsm48_classmark *cm);
240bool osmo_gsm48_classmark1_is_r99(const struct gsm48_classmark1 *cm1);
241bool osmo_gsm48_classmark2_is_r99(const struct gsm48_classmark2 *cm2, uint8_t cm2_len);
242int osmo_gsm48_classmark_supports_a5(const struct osmo_gsm48_classmark *cm, uint8_t a5);
243const char *osmo_gsm48_classmark_a5_name(const struct osmo_gsm48_classmark *cm);
Harald Welte4a62eda2019-03-18 18:27:00 +0100244char *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 +0100245char *osmo_gsm48_classmark_a5_name_c(const void *ctx, const struct osmo_gsm48_classmark *cm);
Neels Hofmeyr7740d262019-01-16 16:53:26 +0100246void osmo_gsm48_classmark_update(struct osmo_gsm48_classmark *dst, const struct osmo_gsm48_classmark *src);
Pau Espin Pedrolb99f4ca2019-10-31 13:35:22 +0100247int8_t osmo_gsm48_rfpowercap2powerclass(enum gsm_band band, uint8_t rf_power_cap);
Andreas Eversberg014cb872010-07-12 09:11:00 +0200248/* Chapter 10.5.2.1b.3 */
249struct gsm48_range_1024 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100250#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200251 uint8_t w1_hi:2,
252 f0:1,
253 form_id:5;
254 uint8_t w1_lo;
255 uint8_t w2_hi;
256 uint8_t w3_hi:7,
257 w2_lo:1;
258 uint8_t w4_hi:6,
259 w3_lo:2;
260 uint8_t w5_hi:6,
261 w4_lo:2;
262 uint8_t w6_hi:6,
263 w5_lo:2;
264 uint8_t w7_hi:6,
265 w6_lo:2;
266 uint8_t w8_hi:6,
267 w7_lo:2;
268 uint8_t w9:7,
269 w8_lo:1;
270 uint8_t w11_hi:1,
271 w10:7;
272 uint8_t w12_hi:2,
273 w11_lo:6;
274 uint8_t w13_hi:3,
275 w12_lo:5;
276 uint8_t w14_hi:4,
277 w13_lo:4;
278 uint8_t w15_hi:5,
279 w14_lo:3;
280 uint8_t w16:6,
281 w15_lo:2;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100282#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100283/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100284 uint8_t form_id:5, f0:1, w1_hi:2;
285 uint8_t w1_lo;
286 uint8_t w2_hi;
287 uint8_t w2_lo:1, w3_hi:7;
288 uint8_t w3_lo:2, w4_hi:6;
289 uint8_t w4_lo:2, w5_hi:6;
290 uint8_t w5_lo:2, w6_hi:6;
291 uint8_t w6_lo:2, w7_hi:6;
292 uint8_t w7_lo:2, w8_hi:6;
293 uint8_t w8_lo:1, w9:7;
294 uint8_t w10:7, w11_hi:1;
295 uint8_t w11_lo:6, w12_hi:2;
296 uint8_t w12_lo:5, w13_hi:3;
297 uint8_t w13_lo:4, w14_hi:4;
298 uint8_t w14_lo:3, w15_hi:5;
299 uint8_t w15_lo:2, w16:6;
300#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200301} __attribute__ ((packed));
302
303/* Chapter 10.5.2.1b.4 */
304struct gsm48_range_512 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100305#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200306 uint8_t orig_arfcn_hi:1,
307 form_id:7;
308 uint8_t orig_arfcn_mid;
309 uint8_t w1_hi:7,
310 orig_arfcn_lo:1;
311 uint8_t w2_hi:6,
312 w1_lo:2;
313 uint8_t w3_hi:6,
314 w2_lo:2;
315 uint8_t w4_hi:6,
316 w3_lo:2;
317 uint8_t w5:7,
318 w4_lo:1;
319 uint8_t w7_hi:1,
320 w6:7;
321 uint8_t w8_hi:2,
322 w7_lo:6;
323 uint8_t w9_hi:4,
324 w8_lo:4;
325 uint8_t w10:6,
326 w9_lo:2;
327 uint8_t w12_hi:2,
328 w11:6;
329 uint8_t w13_hi:4,
330 w12_lo:4;
331 uint8_t w14:6,
332 w13_lo:2;
333 uint8_t w16_hi:2,
334 w15:6;
335 uint8_t w17:5,
336 w16_lo:3;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100337#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100338/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100339 uint8_t form_id:7, orig_arfcn_hi:1;
340 uint8_t orig_arfcn_mid;
341 uint8_t orig_arfcn_lo:1, w1_hi:7;
342 uint8_t w1_lo:2, w2_hi:6;
343 uint8_t w2_lo:2, w3_hi:6;
344 uint8_t w3_lo:2, w4_hi:6;
345 uint8_t w4_lo:1, w5:7;
346 uint8_t w6:7, w7_hi:1;
347 uint8_t w7_lo:6, w8_hi:2;
348 uint8_t w8_lo:4, w9_hi:4;
349 uint8_t w9_lo:2, w10:6;
350 uint8_t w11:6, w12_hi:2;
351 uint8_t w12_lo:4, w13_hi:4;
352 uint8_t w13_lo:2, w14:6;
353 uint8_t w15:6, w16_hi:2;
354 uint8_t w16_lo:3, w17:5;
355#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200356} __attribute__ ((packed));
357
358/* Chapter 10.5.2.1b.5 */
359struct gsm48_range_256 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100360#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200361 uint8_t orig_arfcn_hi:1,
362 form_id:7;
363 uint8_t orig_arfcn_mid;
364 uint8_t w1_hi:7,
365 orig_arfcn_lo:1;
366 uint8_t w2:7,
367 w1_lo:1;
368 uint8_t w4_hi:1,
369 w3:7;
370 uint8_t w5_hi:3,
371 w4_lo:5;
372 uint8_t w6_hi:5,
373 w5_lo:3;
374 uint8_t w8_hi:1,
375 w7:6,
376 w6_lo:1;
377 uint8_t w9_hi:4,
378 w8_lo:4;
379 uint8_t w11_hi:2,
380 w10:5,
381 w9_lo:1;
382 uint8_t w12:5,
383 w11_lo:3;
384 uint8_t w14_hi:3,
385 w13:5;
386 uint8_t w16_hi:1,
387 w15:5,
388 w14_lo:2;
389 uint8_t w18_hi:1,
390 w17:4,
391 w16_lo:3;
392 uint8_t w20_hi:1,
393 w19:4,
394 w18_lo:3;
395 uint8_t spare:1,
396 w21:4,
397 w20_lo:3;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100398#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100399/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100400 uint8_t form_id:7, orig_arfcn_hi:1;
401 uint8_t orig_arfcn_mid;
402 uint8_t orig_arfcn_lo:1, w1_hi:7;
403 uint8_t w1_lo:1, w2:7;
404 uint8_t w3:7, w4_hi:1;
405 uint8_t w4_lo:5, w5_hi:3;
406 uint8_t w5_lo:3, w6_hi:5;
407 uint8_t w6_lo:1, w7:6, w8_hi:1;
408 uint8_t w8_lo:4, w9_hi:4;
409 uint8_t w9_lo:1, w10:5, w11_hi:2;
410 uint8_t w11_lo:3, w12:5;
411 uint8_t w13:5, w14_hi:3;
412 uint8_t w14_lo:2, w15:5, w16_hi:1;
413 uint8_t w16_lo:3, w17:4, w18_hi:1;
414 uint8_t w18_lo:3, w19:4, w20_hi:1;
415 uint8_t w20_lo:3, w21:4, spare:1;
416#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200417} __attribute__ ((packed));
418
419/* Chapter 10.5.2.1b.6 */
420struct gsm48_range_128 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100421#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200422 uint8_t orig_arfcn_hi:1,
423 form_id:7;
424 uint8_t orig_arfcn_mid;
425 uint8_t w1:7,
426 orig_arfcn_lo:1;
427 uint8_t w3_hi:2,
428 w2:6;
429 uint8_t w4_hi:4,
430 w3_lo:4;
431 uint8_t w6_hi:2,
432 w5:5,
433 w4_lo:1;
434 uint8_t w7:5,
435 w6_lo:3;
436 uint8_t w9:4,
437 w8:4;
438 uint8_t w11:4,
439 w10:4;
440 uint8_t w13:4,
441 w12:4;
442 uint8_t w15:4,
443 w14:4;
444 uint8_t w18_hi:2,
445 w17:3,
446 w16:3;
447 uint8_t w21_hi:1,
448 w20:3,
449 w19:3,
450 w18_lo:1;
451 uint8_t w23:3,
452 w22:3,
453 w21_lo:2;
454 uint8_t w26_hi:2,
455 w25:3,
456 w24:3;
457 uint8_t spare:1,
458 w28:3,
459 w27:3,
460 w26_lo:1;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100461#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100462/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100463 uint8_t form_id:7, orig_arfcn_hi:1;
464 uint8_t orig_arfcn_mid;
465 uint8_t orig_arfcn_lo:1, w1:7;
466 uint8_t w2:6, w3_hi:2;
467 uint8_t w3_lo:4, w4_hi:4;
468 uint8_t w4_lo:1, w5:5, w6_hi:2;
469 uint8_t w6_lo:3, w7:5;
470 uint8_t w8:4, w9:4;
471 uint8_t w10:4, w11:4;
472 uint8_t w12:4, w13:4;
473 uint8_t w14:4, w15:4;
474 uint8_t w16:3, w17:3, w18_hi:2;
475 uint8_t w18_lo:1, w19:3, w20:3, w21_hi:1;
476 uint8_t w21_lo:2, w22:3, w23:3;
477 uint8_t w24:3, w25:3, w26_hi:2;
478 uint8_t w26_lo:1, w27:3, w28:3, spare:1;
479#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200480} __attribute__ ((packed));
481
482/* Chapter 10.5.2.1b.7 */
483struct gsm48_var_bit {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100484#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200485 uint8_t orig_arfcn_hi:1,
486 form_id:7;
487 uint8_t orig_arfcn_mid;
488 uint8_t rrfcn1_7:7,
489 orig_arfcn_lo:1;
490 uint8_t rrfcn8_111[13];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100491#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100492/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100493 uint8_t form_id:7, orig_arfcn_hi:1;
494 uint8_t orig_arfcn_mid;
495 uint8_t orig_arfcn_lo:1, rrfcn1_7:7;
496 uint8_t rrfcn8_111[13];
497#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100498} __attribute__ ((packed));
499
500/* Chapter 10.5.2.5 */
501struct gsm48_chan_desc {
502 uint8_t chan_nr;
503 union {
504 struct {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100505#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100506 uint8_t maio_high:4,
507 h:1,
508 tsc:3;
509 uint8_t hsn:6,
510 maio_low:2;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100511#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100512/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100513 uint8_t tsc:3, h:1, maio_high:4;
514 uint8_t maio_low:2, hsn:6;
515#endif
Andreas Eversberg4b332d72012-02-07 20:02:17 +0100516 } __attribute__ ((packed)) h1;
Harald Welteec8b4502010-02-20 20:34:29 +0100517 struct {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100518#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100519 uint8_t arfcn_high:2,
520 spare:2,
521 h:1,
522 tsc:3;
523 uint8_t arfcn_low;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100524#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100525/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100526 uint8_t tsc:3, h:1, spare:2, arfcn_high:2;
527 uint8_t arfcn_low;
528#endif
Andreas Eversberg4b332d72012-02-07 20:02:17 +0100529 } __attribute__ ((packed)) h0;
530 } __attribute__ ((packed));
Harald Welteec8b4502010-02-20 20:34:29 +0100531} __attribute__ ((packed));
532
Andreas Eversberg014cb872010-07-12 09:11:00 +0200533/* Chapter 10.5.2.20 */
534struct gsm48_meas_res {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100535#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200536 uint8_t rxlev_full:6,
537 dtx_used:1,
538 ba_used:1;
539 uint8_t rxlev_sub:6,
540 meas_valid:1,
541 spare:1;
542 uint8_t no_nc_n_hi:1,
543 rxqual_sub:3,
544 rxqual_full:3,
545 spare2:1;
546 uint8_t rxlev_nc1:6,
547 no_nc_n_lo:2;
548 uint8_t bsic_nc1_hi:3,
549 bcch_f_nc1:5;
550 uint8_t rxlev_nc2_hi:5,
551 bsic_nc1_lo:3;
552 uint8_t bsic_nc2_hi:2,
553 bcch_f_nc2:5,
554 rxlev_nc2_lo:1;
555 uint8_t rxlev_nc3_hi:4,
556 bsic_nc2_lo:4;
557 uint8_t bsic_nc3_hi:1,
558 bcch_f_nc3:5,
559 rxlev_nc3_lo:2;
560 uint8_t rxlev_nc4_hi:3,
561 bsic_nc3_lo:5;
562 uint8_t bcch_f_nc4:5,
563 rxlev_nc4_lo:3;
564 uint8_t rxlev_nc5_hi:2,
565 bsic_nc4:6;
566 uint8_t bcch_f_nc5_hi:4,
567 rxlev_nc5_lo:4;
568 uint8_t rxlev_nc6_hi:1,
569 bsic_nc5:6,
570 bcch_f_nc5_lo:1;
571 uint8_t bcch_f_nc6_hi:3,
572 rxlev_nc6_lo:5;
573 uint8_t bsic_nc6:6,
574 bcch_f_nc6_lo:2;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100575#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100576/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100577 uint8_t ba_used:1, dtx_used:1, rxlev_full:6;
578 uint8_t spare:1, meas_valid:1, rxlev_sub:6;
579 uint8_t spare2:1, rxqual_full:3, rxqual_sub:3, no_nc_n_hi:1;
580 uint8_t no_nc_n_lo:2, rxlev_nc1:6;
581 uint8_t bcch_f_nc1:5, bsic_nc1_hi:3;
582 uint8_t bsic_nc1_lo:3, rxlev_nc2_hi:5;
583 uint8_t rxlev_nc2_lo:1, bcch_f_nc2:5, bsic_nc2_hi:2;
584 uint8_t bsic_nc2_lo:4, rxlev_nc3_hi:4;
585 uint8_t rxlev_nc3_lo:2, bcch_f_nc3:5, bsic_nc3_hi:1;
586 uint8_t bsic_nc3_lo:5, rxlev_nc4_hi:3;
587 uint8_t rxlev_nc4_lo:3, bcch_f_nc4:5;
588 uint8_t bsic_nc4:6, rxlev_nc5_hi:2;
589 uint8_t rxlev_nc5_lo:4, bcch_f_nc5_hi:4;
590 uint8_t bcch_f_nc5_lo:1, bsic_nc5:6, rxlev_nc6_hi:1;
591 uint8_t rxlev_nc6_lo:5, bcch_f_nc6_hi:3;
592 uint8_t bcch_f_nc6_lo:2, bsic_nc6:6;
593#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200594} __attribute__ ((packed));
595
Vadim Yanitskiy190b6ef2021-11-04 17:21:11 +0300596/*! Check if the given mr contains valid measurement results */
597static inline bool gsm48_meas_res_is_valid(const struct gsm48_meas_res *mr)
598{
599 return (mr->meas_valid == 0); /* 0 means valid */
600}
601
Harald Welteec8b4502010-02-20 20:34:29 +0100602/* Chapter 10.5.2.21aa */
603struct gsm48_multi_rate_conf {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100604#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100605 uint8_t smod : 2,
606 spare: 1,
607 icmi : 1,
608 nscb : 1,
609 ver : 3;
610 uint8_t m4_75 : 1,
611 m5_15 : 1,
612 m5_90 : 1,
613 m6_70 : 1,
614 m7_40 : 1,
615 m7_95 : 1,
616 m10_2 : 1,
617 m12_2 : 1;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100618#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100619/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100620 uint8_t ver:3, nscb:1, icmi:1, spare:1, smod:2;
621 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;
622#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100623} __attribute__((packed));
624
Andreas Eversberg014cb872010-07-12 09:11:00 +0200625/* Chapter 10.5.2.28(a) */
626struct gsm48_power_cmd {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100627#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200628 uint8_t power_level:5,
629 spare:2,
630 atc:1;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100631#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100632/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100633 uint8_t atc:1, spare:2, power_level:5;
634#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200635} __attribute__((packed));
636
637/* Chapter 10.5.2.29 */
638struct gsm48_rach_control {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100639#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200640 uint8_t re :1,
641 cell_bar :1,
642 tx_integer :4,
643 max_trans :2;
Stefan Sperling18595152018-02-06 13:20:23 +0100644 uint8_t t2; /* ACC 8-15 barred flags */
645 uint8_t t3; /* ACC 0-7 barred flags */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100646#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100647/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100648 uint8_t max_trans:2, tx_integer:4, cell_bar:1, re:1;
649 uint8_t t2;
650 uint8_t t3;
651#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200652} __attribute__ ((packed));
653
Stefan Sperling18595152018-02-06 13:20:23 +0100654/*
655 * Mark an Access Control Class as barred.
656 * \param[in] rach_control A Rach Control Information Element.
657 * \param[in] acc Access Control Class number (0 - 15) which shall be barred.
658 */
659static inline void gsm48_barr_acc(struct gsm48_rach_control *rach_control, unsigned int acc)
660{
Vadim Yanitskiyb8734ba2019-06-12 15:50:57 +0700661 OSMO_ASSERT(acc <= 15);
Stefan Sperling18595152018-02-06 13:20:23 +0100662 if (acc >= 8)
663 rach_control->t2 |= (1 << (acc - 8));
664 else
665 rach_control->t3 |= (1 << (acc));
666}
667
668/*
669 * Mark an Access Control Class as allowed.
670 * \param[in] rach_control A Rach Control Information Element.
671 * \param[in] acc Access Control Class number (0 - 15) which shall be allowed.
672 */
673static inline void gsm48_allow_acc(struct gsm48_rach_control *rach_control, unsigned int acc)
674{
Vadim Yanitskiyb8734ba2019-06-12 15:50:57 +0700675 OSMO_ASSERT(acc <= 15);
Stefan Sperling18595152018-02-06 13:20:23 +0100676 if (acc >= 8)
677 rach_control->t2 &= ~(1 << (acc - 8));
678 else
679 rach_control->t3 &= ~(1 << (acc));
680}
681
682/*
683 * Indicate whether an Access Control Class is barred.
684 * \param[in] rach_control A Rach Control Information Element.
685 * \param[in] acc Access Control Class number (0 - 15).
686 * \returns true if the Access Control class is barred, false otherwise
687 */
688static inline bool gsm48_acc_is_barred(struct gsm48_rach_control *rach_control, unsigned int acc)
689{
Vadim Yanitskiyb8734ba2019-06-12 15:50:57 +0700690 OSMO_ASSERT(acc <= 15);
Stefan Sperling18595152018-02-06 13:20:23 +0100691 if (acc >= 8)
692 return (rach_control->t2 & (1 << (acc - 8))) != 0;
693 return (rach_control->t3 & (1 << (acc))) != 0;
694}
Andreas Eversberg014cb872010-07-12 09:11:00 +0200695
Harald Welteec8b4502010-02-20 20:34:29 +0100696/* Chapter 10.5.2.30 */
697struct gsm48_req_ref {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100698#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100699 uint8_t ra;
700 uint8_t t3_high:3,
Andreas Eversberg93364fc2010-06-25 02:50:06 +0200701 t1:5;
Harald Welteec8b4502010-02-20 20:34:29 +0100702 uint8_t t2:5,
703 t3_low:3;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100704#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100705/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100706 uint8_t ra;
707 uint8_t t1:5, t3_high:3;
708 uint8_t t3_low:3, t2:5;
709#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100710} __attribute__ ((packed));
711
Andreas Eversberg014cb872010-07-12 09:11:00 +0200712/* Chapter 10.5.2.38 */
713struct gsm48_start_time {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100714#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200715 uint8_t t3_high:3,
716 t1:5;
717 uint8_t t2:5,
718 t3_low:3;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100719#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100720/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100721 uint8_t t1:5, t3_high:3;
722 uint8_t t3_low:3, t2:5;
723#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200724} __attribute__ ((packed));
725
726/* Chapter 10.5.2.39 */
727struct gsm48_sync_ind {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100728#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +0200729 uint8_t si:2,
730 rot:1,
731 nci:1,
732 sync_ie:4;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100733#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100734/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100735 uint8_t sync_ie:4, nci:1, rot:1, si:2;
736#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +0200737} __attribute__((packed));
738
Harald Welteec8b4502010-02-20 20:34:29 +0100739/*
740 * Chapter 9.1.5/9.1.6
741 *
742 * For 9.1.6 the chan_desc has the meaning of 10.5.2.5a
743 */
744struct gsm48_chan_mode_modify {
745 struct gsm48_chan_desc chan_desc;
746 uint8_t mode;
747} __attribute__ ((packed));
748
Vadim Yanitskiy8c7f0232023-03-23 05:43:07 +0700749/*! 10.5.2.6 Channel Mode value */
Harald Welteec8b4502010-02-20 20:34:29 +0100750enum gsm48_chan_mode {
Vadim Yanitskiy8c7f0232023-03-23 05:43:07 +0700751 /*! Signalling only (TCH/F or TCH/H) */
Harald Welteec8b4502010-02-20 20:34:29 +0100752 GSM48_CMODE_SIGN = 0x00,
Vadim Yanitskiy8c7f0232023-03-23 05:43:07 +0700753 /*! Speech: FR (TCH/FS) or HR (TCH/HS) */
Harald Welteec8b4502010-02-20 20:34:29 +0100754 GSM48_CMODE_SPEECH_V1 = 0x01,
Vadim Yanitskiy8c7f0232023-03-23 05:43:07 +0700755 /*! Speech: EFR (TCH/EFS) */
756 GSM48_CMODE_SPEECH_EFR = 0x21, /*!< a.k.a. V2 */
757 /*! Speech: AMR (TCH/AFS or TCH/AHS) */
758 GSM48_CMODE_SPEECH_AMR = 0x41, /*!< a.k.a. V3 */
Vadim Yanitskiy1c88ff92023-03-23 06:33:51 +0700759 /*! Speech: OFR AMR-WB (O-TCH/WFS) or OHR AMR-WB (O-TCH/WHS) */
760 GSM48_CMODE_SPEECH_V4 = 0x81,
761 /*! Speech: FR AMR-WB (TCH/WFS) */
762 GSM48_CMODE_SPEECH_V5 = 0x82,
763 /*! Speech: OHR AMR (O-TCH/AHS) */
764 GSM48_CMODE_SPEECH_V6 = 0x83,
Vadim Yanitskiy8c7f0232023-03-23 05:43:07 +0700765
766 /*! CSD: 14.5 kbit/s radio interface rate, 14.4 kbit/s services (TCH/F14.4) */
Harald Welteec8b4502010-02-20 20:34:29 +0100767 GSM48_CMODE_DATA_14k5 = 0x0f,
Vadim Yanitskiy8c7f0232023-03-23 05:43:07 +0700768 /*! CSD: 12.0 kbit/s radio interface rate, 9.6 kbit/s services (TCH/F9.6) */
Harald Welteec8b4502010-02-20 20:34:29 +0100769 GSM48_CMODE_DATA_12k0 = 0x03,
Vadim Yanitskiy8c7f0232023-03-23 05:43:07 +0700770 /*! CSD: 6.0 kbit/s radio interface rate, 4.8 kbit/s services (TCH/{F,H}4.8) */
Harald Welteec8b4502010-02-20 20:34:29 +0100771 GSM48_CMODE_DATA_6k0 = 0x0b,
Vadim Yanitskiy8c7f0232023-03-23 05:43:07 +0700772 /*! CSD: 3.6 kbit/s radio interface rate, 2.4 kbit/s and less services (TCH/{F,H}2.4) */
Bhaskar31e844b2013-05-16 17:06:35 +0530773 GSM48_CMODE_DATA_3k6 = 0x13,
Vadim Yanitskiy8c7f0232023-03-23 05:43:07 +0700774
775 /*! Same as GSM48_CMODE_SPEECH_V1, in VAMOS mode */
Neels Hofmeyra9da9f72021-04-16 15:36:58 +0200776 GSM48_CMODE_SPEECH_V1_VAMOS = 0xc1,
Vadim Yanitskiy8c7f0232023-03-23 05:43:07 +0700777 /*! Same as GSM48_CMODE_SPEECH_EFR, in VAMOS mode */
Neels Hofmeyra9da9f72021-04-16 15:36:58 +0200778 GSM48_CMODE_SPEECH_V2_VAMOS = 0xc2,
Vadim Yanitskiy8c7f0232023-03-23 05:43:07 +0700779 /*! Same as GSM48_CMODE_SPEECH_AMR, in VAMOS mode */
Neels Hofmeyra9da9f72021-04-16 15:36:58 +0200780 GSM48_CMODE_SPEECH_V3_VAMOS = 0xc3,
Vadim Yanitskiy1c88ff92023-03-23 06:33:51 +0700781 /*! Speech: GSM48_CMODE_SPEECH_V5, in VAMOS mode */
Neels Hofmeyra9da9f72021-04-16 15:36:58 +0200782 GSM48_CMODE_SPEECH_V5_VAMOS = 0xc5,
Harald Welteec8b4502010-02-20 20:34:29 +0100783};
784
Maxfb348ee2016-03-30 21:14:53 +0200785extern const struct value_string gsm48_chan_mode_names[];
Philipp Maier5796a212018-07-12 17:48:26 +0200786static inline const char *gsm48_chan_mode_name(enum gsm48_chan_mode val)
787{ return get_value_string(gsm48_chan_mode_names, val); }
Maxfb348ee2016-03-30 21:14:53 +0200788
Harald Welteec8b4502010-02-20 20:34:29 +0100789/* Chapter 9.1.2 */
790struct gsm48_ass_cmd {
791 /* Semantic is from 10.5.2.5a */
792 struct gsm48_chan_desc chan_desc;
793 uint8_t power_command;
794 uint8_t data[0];
795} __attribute__((packed));
796
Andreas Eversbergfa832012010-09-01 23:37:07 +0200797/* Chapter 9.1.13 */
798struct gsm48_frq_redef {
799 /* Semantic is from 10.5.2.5a */
800 struct gsm48_chan_desc chan_desc;
801 uint8_t mob_alloc_len;
802 uint8_t mob_alloc[0];
803} __attribute__((packed));
804
Harald Welte548e3712017-07-10 22:32:08 +0200805/* Chapter 9.1.13b GPRS suspension request */
806struct gsm48_gprs_susp_req {
807 uint32_t tlli;
808 uint8_t ra_id[6];
809 uint8_t cause;
810 uint8_t options[0];
811} __attribute__ ((packed));
812
Harald Welteec8b4502010-02-20 20:34:29 +0100813/* Chapter 10.5.2.2 */
814struct gsm48_cell_desc {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100815#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100816 uint8_t bcc:3,
817 ncc:3,
818 arfcn_hi:2;
819 uint8_t arfcn_lo;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100820#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100821/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100822 uint8_t arfcn_hi:2, ncc:3, bcc:3;
823 uint8_t arfcn_lo;
824#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100825} __attribute__((packed));
826
827/* Chapter 9.1.15 */
828struct gsm48_ho_cmd {
829 struct gsm48_cell_desc cell_desc;
830 struct gsm48_chan_desc chan_desc;
831 uint8_t ho_ref;
832 uint8_t power_command;
833 uint8_t data[0];
834} __attribute__((packed));
835
836/* Chapter 9.1.18 */
837struct gsm48_imm_ass {
838 uint8_t l2_plen;
839 uint8_t proto_discr;
840 uint8_t msg_type;
841 uint8_t page_mode;
842 struct gsm48_chan_desc chan_desc;
843 struct gsm48_req_ref req_ref;
844 uint8_t timing_advance;
845 uint8_t mob_alloc_len;
846 uint8_t mob_alloc[0];
847} __attribute__ ((packed));
848
Holger Hans Peter Freyther5dcef3c2010-05-15 22:35:25 +0800849/* Chapter 9.1.25 */
850struct gsm48_pag_resp {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100851#if OSMO_IS_LITTLE_ENDIAN
Holger Hans Peter Freyther5dcef3c2010-05-15 22:35:25 +0800852 uint8_t spare:4,
853 key_seq:4;
Pau Espin Pedrolba5a9b92019-11-04 15:41:32 +0100854 union {
855 uint32_t classmark2; /* Backward compatibility */
856 struct {
857 uint8_t cm2_len;
858 struct gsm48_classmark2 cm2;
859 };
860 };
Holger Hans Peter Freyther5dcef3c2010-05-15 22:35:25 +0800861 uint8_t mi_len;
862 uint8_t mi[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100863#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100864/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100865 uint8_t key_seq:4, spare:4;
Pau Espin Pedrolba5a9b92019-11-04 15:41:32 +0100866 union {
Neels Hofmeyr534f0f42020-05-14 17:28:39 +0200867 uint32_t classmark2;
Pau Espin Pedrolba5a9b92019-11-04 15:41:32 +0100868 struct {
869 uint8_t cm2_len;
870 struct gsm48_classmark2 cm2;
871 };
872 };
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100873 uint8_t mi_len;
874 uint8_t mi[0];
875#endif
Holger Hans Peter Freyther5dcef3c2010-05-15 22:35:25 +0800876} __attribute__ ((packed));
877
Harald Welteec8b4502010-02-20 20:34:29 +0100878/* Chapter 10.5.1.3 */
879struct gsm48_loc_area_id {
880 uint8_t digits[3]; /* BCD! */
881 uint16_t lac;
882} __attribute__ ((packed));
883
884/* Section 9.2.2 */
885struct gsm48_auth_req {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100886#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100887 uint8_t key_seq:4,
888 spare:4;
889 uint8_t rand[16];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100890#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100891/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100892 uint8_t spare:4, key_seq:4;
893 uint8_t rand[16];
894#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100895} __attribute__ ((packed));
896
Sylvain Munautd005eab2010-06-10 13:30:50 +0200897/* Section 9.2.3 */
898struct gsm48_auth_resp {
899 uint8_t sres[4];
900} __attribute__ ((packed));
901
Harald Welteec8b4502010-02-20 20:34:29 +0100902/* Section 9.2.15 */
903struct gsm48_loc_upd_req {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100904#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100905 uint8_t type:4,
906 key_seq:4;
907 struct gsm48_loc_area_id lai;
908 struct gsm48_classmark1 classmark1;
909 uint8_t mi_len;
910 uint8_t mi[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100911#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100912/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100913 uint8_t key_seq:4, type:4;
914 struct gsm48_loc_area_id lai;
915 struct gsm48_classmark1 classmark1;
916 uint8_t mi_len;
917 uint8_t mi[0];
918#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100919} __attribute__ ((packed));
920
921/* Section 10.1 */
922struct gsm48_hdr {
923 uint8_t proto_discr;
924 uint8_t msg_type;
925 uint8_t data[0];
926} __attribute__ ((packed));
927
928/* Section 9.1.3x System information Type header */
929struct gsm48_system_information_type_header {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100930#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100931 uint8_t l2_plen;
932 uint8_t rr_protocol_discriminator :4,
Pau Espin Pedrolab6d6cf2019-10-31 13:34:57 +0100933 skip_indicator:4;
Harald Welteec8b4502010-02-20 20:34:29 +0100934 uint8_t system_information;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100935#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100936/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100937 uint8_t l2_plen;
938 uint8_t skip_indicator:4, rr_protocol_discriminator:4;
939 uint8_t system_information;
940#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100941} __attribute__ ((packed));
942
Harald Welteec8b4502010-02-20 20:34:29 +0100943/* Section 10.5.2.4 Cell Selection Parameters */
944struct gsm48_cell_sel_par {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100945#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100946 uint8_t ms_txpwr_max_ccch:5, /* GSM 05.08 MS-TXPWR-MAX-CCCH */
947 cell_resel_hyst:3; /* GSM 05.08 CELL-RESELECT-HYSTERESIS */
948 uint8_t rxlev_acc_min:6, /* GSM 05.08 RXLEV-ACCESS-MIN */
949 neci:1,
950 acs:1;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100951#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100952/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100953 uint8_t cell_resel_hyst:3, ms_txpwr_max_ccch:5;
954 uint8_t acs:1, neci:1, rxlev_acc_min:6;
955#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100956} __attribute__ ((packed));
957
Neels Hofmeyrd1c2fc62017-02-21 14:51:40 +0100958/* 3GPP TS 44.018 Section 10.5.2.11 Control Channel Description */
Harald Welteec8b4502010-02-20 20:34:29 +0100959struct gsm48_control_channel_descr {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100960#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100961 uint8_t ccch_conf :3,
962 bs_ag_blks_res :3,
963 att :1,
Neels Hofmeyrd1c2fc62017-02-21 14:51:40 +0100964 mscr :1;
Harald Welteec8b4502010-02-20 20:34:29 +0100965 uint8_t bs_pa_mfrms : 3,
Neels Hofmeyrd1c2fc62017-02-21 14:51:40 +0100966 spare_1 :2,
967 cbq3 :2,
968 spare_2 :1;
Harald Welteec8b4502010-02-20 20:34:29 +0100969 uint8_t t3212;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100970#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100971/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100972 uint8_t mscr:1, att:1, bs_ag_blks_res:3, ccch_conf:3;
973 uint8_t spare_2:1, cbq3:2, spare_1:2, bs_pa_mfrms:3;
974 uint8_t t3212;
975#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100976} __attribute__ ((packed));
977
Maxfe65fa72016-05-10 17:17:05 +0200978enum gsm48_dtx_mode {
979 GSM48_DTX_MAY_BE_USED,
980 GSM48_DTX_SHALL_BE_USED,
981 GSM48_DTX_SHALL_NOT_BE_USED
982};
983
984/* Cell Options for SI6, SACCH (10.5.2.3a.2) or SI3, BCCH (Table 10.5.2.3.1),
985 3GPP TS 44.018 */
Harald Welteec8b4502010-02-20 20:34:29 +0100986struct gsm48_cell_options {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100987#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +0100988 uint8_t radio_link_timeout:4,
989 dtx:2,
990 pwrc:1,
Maxfe65fa72016-05-10 17:17:05 +0200991 /* either DN-IND or top bit of DTX IND */
992 d:1;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100993#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +0100994/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100995 uint8_t d:1, pwrc:1, dtx:2, radio_link_timeout:4;
996#endif
Harald Welteec8b4502010-02-20 20:34:29 +0100997} __attribute__ ((packed));
998
999/* Section 9.2.9 CM service request */
1000struct gsm48_service_request {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001001#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +01001002 uint8_t cm_service_type : 4,
1003 cipher_key_seq : 4;
Pau Espin Pedrolba5a9b92019-11-04 15:41:32 +01001004 union {
1005 uint32_t classmark; /* Backward compatibility */
1006 struct {
1007 uint8_t cm2_len;
1008 struct gsm48_classmark2 classmark2;
1009 };
1010 };
Harald Welteec8b4502010-02-20 20:34:29 +01001011 uint8_t mi_len;
1012 uint8_t mi[0];
1013 /* optional priority level */
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001014#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +01001015/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001016 uint8_t cipher_key_seq:4, cm_service_type:4;
Pau Espin Pedrolba5a9b92019-11-04 15:41:32 +01001017 union {
Neels Hofmeyr534f0f42020-05-14 17:28:39 +02001018 uint32_t classmark;
Pau Espin Pedrolba5a9b92019-11-04 15:41:32 +01001019 struct {
1020 uint8_t cm2_len;
1021 struct gsm48_classmark2 classmark2;
1022 };
1023 };
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001024 uint8_t mi_len;
1025 uint8_t mi[0];
1026#endif
Harald Welteec8b4502010-02-20 20:34:29 +01001027} __attribute__ ((packed));
1028
1029/* Section 9.1.31 System information Type 1 */
1030struct gsm48_system_information_type_1 {
1031 struct gsm48_system_information_type_header header;
1032 uint8_t cell_channel_description[16];
1033 struct gsm48_rach_control rach_control;
1034 uint8_t rest_octets[0]; /* NCH position on the CCCH */
1035} __attribute__ ((packed));
1036
1037/* Section 9.1.32 System information Type 2 */
1038struct gsm48_system_information_type_2 {
1039 struct gsm48_system_information_type_header header;
1040 uint8_t bcch_frequency_list[16];
1041 uint8_t ncc_permitted;
1042 struct gsm48_rach_control rach_control;
1043} __attribute__ ((packed));
1044
Andreas Eversberg014cb872010-07-12 09:11:00 +02001045/* Section 9.1.33 System information Type 2bis */
1046struct gsm48_system_information_type_2bis {
1047 struct gsm48_system_information_type_header header;
1048 uint8_t bcch_frequency_list[16];
1049 struct gsm48_rach_control rach_control;
1050 uint8_t rest_octets[0];
1051} __attribute__ ((packed));
1052
1053/* Section 9.1.34 System information Type 2ter */
1054struct gsm48_system_information_type_2ter {
1055 struct gsm48_system_information_type_header header;
1056 uint8_t ext_bcch_frequency_list[16];
1057 uint8_t rest_octets[0];
1058} __attribute__ ((packed));
1059
Maxe859aec2016-03-11 12:24:04 +01001060/* Section 9.1.34a System information Type 2quater */
1061struct gsm48_system_information_type_2quater {
1062 struct gsm48_system_information_type_header header;
1063 uint8_t rest_octets[0];
1064} __attribute__ ((packed));
1065
Harald Welteec8b4502010-02-20 20:34:29 +01001066/* Section 9.1.35 System information Type 3 */
1067struct gsm48_system_information_type_3 {
1068 struct gsm48_system_information_type_header header;
1069 uint16_t cell_identity;
1070 struct gsm48_loc_area_id lai;
1071 struct gsm48_control_channel_descr control_channel_desc;
1072 struct gsm48_cell_options cell_options;
1073 struct gsm48_cell_sel_par cell_sel_par;
1074 struct gsm48_rach_control rach_control;
1075 uint8_t rest_octets[0];
1076} __attribute__ ((packed));
1077
1078/* Section 9.1.36 System information Type 4 */
1079struct gsm48_system_information_type_4 {
1080 struct gsm48_system_information_type_header header;
1081 struct gsm48_loc_area_id lai;
1082 struct gsm48_cell_sel_par cell_sel_par;
1083 struct gsm48_rach_control rach_control;
1084 /* optional CBCH conditional CBCH... followed by
1085 mandantory SI 4 Reset Octets
1086 */
1087 uint8_t data[0];
1088} __attribute__ ((packed));
1089
1090/* Section 9.1.37 System information Type 5 */
1091struct gsm48_system_information_type_5 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001092#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +01001093 uint8_t rr_protocol_discriminator :4,
Pau Espin Pedrolab6d6cf2019-10-31 13:34:57 +01001094 skip_indicator:4;
Harald Welteec8b4502010-02-20 20:34:29 +01001095 uint8_t system_information;
1096 uint8_t bcch_frequency_list[16];
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001097#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +01001098/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001099 uint8_t skip_indicator:4, rr_protocol_discriminator:4;
1100 uint8_t system_information;
1101 uint8_t bcch_frequency_list[16];
1102#endif
Harald Welteec8b4502010-02-20 20:34:29 +01001103} __attribute__ ((packed));
1104
Andreas Eversberg014cb872010-07-12 09:11:00 +02001105/* Section 9.1.38 System information Type 5bis */
1106struct gsm48_system_information_type_5bis {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001107#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +02001108 uint8_t rr_protocol_discriminator :4,
1109 skip_indicator:4;
1110 uint8_t system_information;
1111 uint8_t bcch_frequency_list[16];
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001112#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +01001113/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001114 uint8_t skip_indicator:4, rr_protocol_discriminator:4;
1115 uint8_t system_information;
1116 uint8_t bcch_frequency_list[16];
1117#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +02001118} __attribute__ ((packed));
1119
1120/* Section 9.1.39 System information Type 5ter */
1121struct gsm48_system_information_type_5ter {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001122#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +02001123 uint8_t rr_protocol_discriminator :4,
1124 skip_indicator:4;
1125 uint8_t system_information;
1126 uint8_t bcch_frequency_list[16];
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001127#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +01001128/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001129 uint8_t skip_indicator:4, rr_protocol_discriminator:4;
1130 uint8_t system_information;
1131 uint8_t bcch_frequency_list[16];
1132#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +02001133} __attribute__ ((packed));
1134
Harald Welteec8b4502010-02-20 20:34:29 +01001135/* Section 9.1.40 System information Type 6 */
1136struct gsm48_system_information_type_6 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001137#if OSMO_IS_LITTLE_ENDIAN
Harald Welteec8b4502010-02-20 20:34:29 +01001138 uint8_t rr_protocol_discriminator :4,
Pau Espin Pedrolab6d6cf2019-10-31 13:34:57 +01001139 skip_indicator:4;
Harald Welteec8b4502010-02-20 20:34:29 +01001140 uint8_t system_information;
1141 uint16_t cell_identity;
1142 struct gsm48_loc_area_id lai;
1143 struct gsm48_cell_options cell_options;
1144 uint8_t ncc_permitted;
1145 uint8_t rest_octets[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001146#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +01001147/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001148 uint8_t skip_indicator:4, rr_protocol_discriminator:4;
1149 uint8_t system_information;
1150 uint16_t cell_identity;
1151 struct gsm48_loc_area_id lai;
1152 struct gsm48_cell_options cell_options;
1153 uint8_t ncc_permitted;
1154 uint8_t rest_octets[0];
1155#endif
Harald Welteec8b4502010-02-20 20:34:29 +01001156} __attribute__ ((packed));
1157
Maxb31a2b52023-01-26 21:31:53 +03001158/* Section 9.1.50 System Information type 10 (ASCI) */
1159struct gsm48_system_information_type_10 {
1160#if OSMO_IS_LITTLE_ENDIAN
1161 uint8_t rr_short_pd:1, /* < RR short PD : bit > See 3GPP TS 24.007 ยง11.3.2 */
1162 msg_type:5, /* < message type : bit(5) > See 3GPP TS 44.018 Table 10.4.2 */
1163 l2_header:2; /* < short layer 2 header : bit(2) > See 3GPP TS 44.006 ยง6.4a */
1164 uint8_t rest_octets[0]; /* < SI10 Rest Octets : bit(160) > See 3GPP TS 44.018 ยง10.5.2.44 */
1165#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +01001166/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Maxb31a2b52023-01-26 21:31:53 +03001167 uint8_t l2_header:2, msg_type:5, rr_short_pd:1;
1168 uint8_t rest_octets[0];
1169#endif
1170} __attribute__ ((packed));
1171
Harald Welteec8b4502010-02-20 20:34:29 +01001172/* Section 9.1.43a System Information type 13 */
1173struct gsm48_system_information_type_13 {
1174 struct gsm48_system_information_type_header header;
1175 uint8_t rest_octets[0];
1176} __attribute__ ((packed));
1177
1178/* Section 9.2.12 IMSI Detach Indication */
1179struct gsm48_imsi_detach_ind {
1180 struct gsm48_classmark1 classmark1;
1181 uint8_t mi_len;
1182 uint8_t mi[0];
1183} __attribute__ ((packed));
1184
Andreas Eversberg014cb872010-07-12 09:11:00 +02001185/* Section 9.1.1 */
1186struct gsm48_add_ass {
1187 /* Semantic is from 10.5.2.5 */
1188 struct gsm48_chan_desc chan_desc;
1189 uint8_t data[0];
1190} __attribute__((packed));
1191
1192/* Section 9.1.3 */
1193struct gsm48_ass_cpl {
1194 uint8_t rr_cause;
1195} __attribute__((packed));
1196
1197/* Section 9.1.4 */
1198struct gsm48_ass_fail {
1199 uint8_t rr_cause;
1200} __attribute__((packed));
1201
Andreas Eversbergfa832012010-09-01 23:37:07 +02001202/* Section 9.1.3 */
1203struct gsm48_ho_cpl {
1204 uint8_t rr_cause;
1205 uint8_t data[0];
1206} __attribute__((packed));
1207
1208/* Section 9.1.4 */
1209struct gsm48_ho_fail {
1210 uint8_t rr_cause;
1211} __attribute__((packed));
1212
Andreas Eversberg014cb872010-07-12 09:11:00 +02001213/* Section 9.1.7 */
1214struct gsm48_chan_rel {
1215 uint8_t rr_cause;
1216 uint8_t data[0];
1217} __attribute__((packed));
1218
1219/* Section 9.1.9 */
1220struct gsm48_cip_mode_cmd {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001221#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +02001222 uint8_t sc:1,
1223 alg_id:3,
Sylvain Munaut77b6f6c2010-09-17 13:55:45 +02001224 cr:1,
1225 spare:3;
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001226#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +01001227/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001228 uint8_t spare:3, cr:1, alg_id:3, sc:1;
1229#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +02001230} __attribute__((packed));
1231
1232/* Section 9.1.11 */
1233struct gsm48_cm_change {
1234 uint8_t cm2_len;
1235 struct gsm48_classmark2 cm2;
1236 uint8_t data[0];
1237} __attribute__((packed));
1238
1239/* Section 9.1.19 */
1240struct gsm48_imm_ass_ext {
1241 uint8_t l2_plen;
1242 uint8_t proto_discr;
1243 uint8_t msg_type;
1244 uint8_t page_mode;
1245 struct gsm48_chan_desc chan_desc1;
1246 struct gsm48_req_ref req_ref1;
1247 uint8_t timing_advance1;
1248 struct gsm48_chan_desc chan_desc2;
1249 struct gsm48_req_ref req_ref2;
1250 uint8_t timing_advance2;
1251 uint8_t mob_alloc_len;
1252 uint8_t mob_alloc[0];
1253} __attribute__ ((packed));
1254
1255/* Section 9.1.20 */
1256struct gsm48_imm_ass_rej {
1257 uint8_t l2_plen;
1258 uint8_t proto_discr;
1259 uint8_t msg_type;
1260 uint8_t page_mode;
1261 struct gsm48_req_ref req_ref1;
1262 uint8_t wait_ind1;
1263 struct gsm48_req_ref req_ref2;
1264 uint8_t wait_ind2;
1265 struct gsm48_req_ref req_ref3;
1266 uint8_t wait_ind3;
1267 struct gsm48_req_ref req_ref4;
1268 uint8_t wait_ind4;
1269 uint8_t rest[0];
1270} __attribute__ ((packed));
1271
1272/* Section 9.1.22 */
1273struct gsm48_paging1 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001274#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +02001275 uint8_t l2_plen;
1276 uint8_t proto_discr;
1277 uint8_t msg_type;
1278 uint8_t pag_mode:2,
1279 spare:2,
1280 cneed1:2,
1281 cneed2:2;
1282 uint8_t data[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001283#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +01001284/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001285 uint8_t l2_plen;
1286 uint8_t proto_discr;
1287 uint8_t msg_type;
1288 uint8_t cneed2:2, cneed1:2, spare:2, pag_mode:2;
1289 uint8_t data[0];
1290#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +02001291} __attribute__((packed));
1292
1293/* Section 9.1.23 */
1294struct gsm48_paging2 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001295#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +02001296 uint8_t l2_plen;
1297 uint8_t proto_discr;
1298 uint8_t msg_type;
1299 uint8_t pag_mode:2,
1300 spare:2,
1301 cneed1:2,
1302 cneed2:2;
1303 uint32_t tmsi1;
1304 uint32_t tmsi2;
1305 uint8_t data[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001306#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +01001307/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001308 uint8_t l2_plen;
1309 uint8_t proto_discr;
1310 uint8_t msg_type;
1311 uint8_t cneed2:2, cneed1:2, spare:2, pag_mode:2;
1312 uint32_t tmsi1;
1313 uint32_t tmsi2;
1314 uint8_t data[0];
1315#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +02001316} __attribute__((packed));
1317
1318/* Section 9.1.24 */
1319struct gsm48_paging3 {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001320#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +02001321 uint8_t l2_plen;
1322 uint8_t proto_discr;
1323 uint8_t msg_type;
1324 uint8_t pag_mode:2,
1325 spare:2,
1326 cneed1:2,
1327 cneed2:2;
1328 uint32_t tmsi1;
1329 uint32_t tmsi2;
1330 uint32_t tmsi3;
1331 uint32_t tmsi4;
1332 uint8_t cneed3:2,
1333 cneed4:2,
1334 spare2:4;
1335 uint8_t rest[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001336#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +01001337/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001338 uint8_t l2_plen;
1339 uint8_t proto_discr;
1340 uint8_t msg_type;
1341 uint8_t cneed2:2, cneed1:2, spare:2, pag_mode:2;
1342 uint32_t tmsi1;
1343 uint32_t tmsi2;
1344 uint32_t tmsi3;
1345 uint32_t tmsi4;
1346 uint8_t spare2:4, cneed4:2, cneed3:2;
1347 uint8_t rest[0];
1348#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +02001349} __attribute__((packed));
1350
1351/* Section 9.1.25 */
1352struct gsm48_pag_rsp {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001353#if OSMO_IS_LITTLE_ENDIAN
Andreas Eversberg014cb872010-07-12 09:11:00 +02001354 uint8_t key_seq:3,
1355 spare:5;
1356 uint8_t cm2_len;
1357 struct gsm48_classmark2 cm2;
1358 uint8_t data[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001359#elif OSMO_IS_BIG_ENDIAN
Oliver Smith0b5c09b2023-02-17 10:35:38 +01001360/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001361 uint8_t spare:5, key_seq:3;
1362 uint8_t cm2_len;
1363 struct gsm48_classmark2 cm2;
1364 uint8_t data[0];
1365#endif
Andreas Eversberg014cb872010-07-12 09:11:00 +02001366} __attribute__((packed));
1367
1368/* Section 9.1.29 */
1369struct gsm48_rr_status {
1370 uint8_t rr_cause;
1371} __attribute__((packed));
1372
Harald Welte3f066dd2017-05-29 15:59:03 +02001373/* 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 +02001374#define GSM48_PDISC_GROUP_CC 0x00
1375#define GSM48_PDISC_BCAST_CC 0x01
1376#define GSM48_PDISC_PDSS1 0x02 /* 04.07 only */
1377#define GSM48_PDISC_CC 0x03
1378#define GSM48_PDISC_PDSS2 0x04 /* 04.07 only */
1379#define GSM48_PDISC_GTTP 0x04 /* 24.007 only */
1380#define GSM48_PDISC_MM 0x05
1381#define GSM48_PDISC_RR 0x06
1382#define GSM48_PDISC_MM_GPRS 0x08
1383#define GSM48_PDISC_SMS 0x09
1384#define GSM48_PDISC_SM_GPRS 0x0a
1385#define GSM48_PDISC_NC_SS 0x0b
1386#define GSM48_PDISC_LOC 0x0c
1387#define GSM48_PDISC_EXTEND 0x0e
1388#define GSM48_PDISC_TEST 0x0f /* as per 11.10, 04.14 */
1389#define GSM48_PDISC_MASK 0x0f
Harald Welteec8b4502010-02-20 20:34:29 +01001390
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +01001391extern const struct value_string gsm48_pdisc_names[];
Harald Welte753ae492019-05-18 11:07:54 +02001392static inline const char *gsm48_pdisc_name(uint8_t val)
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +01001393{ return get_value_string(gsm48_pdisc_names, val); }
1394
Maxfdca25d2016-07-05 16:06:28 +02001395bool gsm48_hdr_gmm_cipherable(const struct gsm48_hdr *hdr);
1396
Harald Welte753ae492019-05-18 11:07:54 +02001397static inline uint8_t gsm48_hdr_pdisc(const struct gsm48_hdr *hdr)
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001398{
1399 /*
1400 * 3GPP TS 24.007 version 12.0.0 Release 12,
1401 * 11.2.3.1.1 Protocol discriminator
1402 */
1403 uint8_t pdisc = hdr->proto_discr & GSM48_PDISC_MASK;
1404 if (pdisc == GSM48_PDISC_EXTEND)
1405 return hdr->proto_discr;
1406 return pdisc;
1407}
1408
Neels Hofmeyrda7bf4d2016-03-14 16:06:48 +01001409static inline uint8_t gsm48_hdr_trans_id(const struct gsm48_hdr *hdr)
1410{
1411 /*
1412 * 3GPP TS 24.007 version 12.0.0 Release 12,
1413 * 11.2.3.1.3 Transaction identifier
1414 */
1415 return (hdr->proto_discr & 0xf0) >> 4;
1416}
1417
Maxda34bf02016-07-17 16:37:56 +02001418#define GSM48_TA_INVALID 220
1419
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001420/*! Check if TA is valid according to 3GPP TS 44.018 ยง 10.5.2.40
Maxedb57e72016-07-14 11:35:17 +02001421 * \param[in] ta Timing Advance value
1422 * \returns true if ta is valid, false otherwise
1423 * Note: Rules for GSM400 band are ignored as it's not implemented in practice.
1424 */
1425static inline bool gsm48_ta_is_valid(uint8_t ta)
1426{
1427 return (ta < 64);
1428}
1429
Neels Hofmeyrda7bf4d2016-03-14 16:06:48 +01001430static inline uint8_t gsm48_hdr_trans_id_flip_ti(const struct gsm48_hdr *hdr)
1431{
1432 return gsm48_hdr_trans_id(hdr) ^ 0x08;
1433}
1434
1435static inline uint8_t gsm48_hdr_trans_id_no_ti(const struct gsm48_hdr *hdr)
1436{
1437 return gsm48_hdr_trans_id(hdr) & 0x07;
1438}
1439
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001440static inline uint8_t gsm48_hdr_msg_type_r98(const struct gsm48_hdr *hdr)
1441{
1442 /*
1443 * 3GPP TS 24.007 version 12.0.0 Release 12,
1444 * 11.2.3.2.1 Message type octet (when accessing Release 98 and older
1445 * networks only)
1446 */
1447 switch (gsm48_hdr_pdisc(hdr)) {
1448 case GSM48_PDISC_MM:
1449 case GSM48_PDISC_CC:
1450 case GSM48_PDISC_NC_SS:
1451 case GSM48_PDISC_GROUP_CC:
1452 case GSM48_PDISC_BCAST_CC:
1453 case GSM48_PDISC_LOC:
Harald Welte143aed72018-02-03 21:14:47 +01001454 return hdr->msg_type & 0x3f;
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001455 default:
1456 return hdr->msg_type;
1457 }
1458}
1459
1460static inline uint8_t gsm48_hdr_msg_type_r99(const struct gsm48_hdr *hdr)
1461{
1462 /*
1463 * 3GPP TS 24.007 version 12.0.0 Release 12,
1464 * 11.2.3.2.2 Message type octet (when accessing Release 99 and newer
1465 * networks)
1466 */
1467 switch (gsm48_hdr_pdisc(hdr)) {
1468 case GSM48_PDISC_MM:
1469 case GSM48_PDISC_CC:
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001470 case GSM48_PDISC_NC_SS:
Harald Weltef1076ed2018-02-03 21:16:45 +01001471 return hdr->msg_type & 0x3f;
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001472 case GSM48_PDISC_GROUP_CC:
1473 case GSM48_PDISC_BCAST_CC:
1474 case GSM48_PDISC_LOC:
Harald Welte143aed72018-02-03 21:14:47 +01001475 return hdr->msg_type & 0x3f;
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001476 default:
1477 return hdr->msg_type;
1478 }
1479}
1480
Maxfe65fa72016-05-10 17:17:05 +02001481void gsm48_set_dtx(struct gsm48_cell_options *op, enum gsm48_dtx_mode full,
1482 enum gsm48_dtx_mode half, bool is_bcch);
1483
Neels Hofmeyrc656fae2016-03-14 16:06:47 +01001484#define gsm48_hdr_msg_type gsm48_hdr_msg_type_r99
Neels Hofmeyr282e9082016-03-14 16:06:46 +01001485
Harald Welteec8b4502010-02-20 20:34:29 +01001486/* Section 10.4 */
1487#define GSM48_MT_RR_INIT_REQ 0x3c
1488#define GSM48_MT_RR_ADD_ASS 0x3b
1489#define GSM48_MT_RR_IMM_ASS 0x3f
1490#define GSM48_MT_RR_IMM_ASS_EXT 0x39
1491#define GSM48_MT_RR_IMM_ASS_REJ 0x3a
Philipp72e43f02016-10-27 13:35:20 +02001492#define GSM48_MT_RR_DTM_ASS_FAIL 0x48
1493#define GSM48_MT_RR_DTM_REJECT 0x49
1494#define GSM48_MT_RR_DTM_REQUEST 0x4A
1495#define GSM48_MT_RR_PACKET_ASS 0x4B
Harald Welteec8b4502010-02-20 20:34:29 +01001496
1497#define GSM48_MT_RR_CIPH_M_CMD 0x35
1498#define GSM48_MT_RR_CIPH_M_COMPL 0x32
1499
1500#define GSM48_MT_RR_CFG_CHG_CMD 0x30
1501#define GSM48_MT_RR_CFG_CHG_ACK 0x31
1502#define GSM48_MT_RR_CFG_CHG_REJ 0x33
1503
1504#define GSM48_MT_RR_ASS_CMD 0x2e
1505#define GSM48_MT_RR_ASS_COMPL 0x29
1506#define GSM48_MT_RR_ASS_FAIL 0x2f
1507#define GSM48_MT_RR_HANDO_CMD 0x2b
1508#define GSM48_MT_RR_HANDO_COMPL 0x2c
1509#define GSM48_MT_RR_HANDO_FAIL 0x28
1510#define GSM48_MT_RR_HANDO_INFO 0x2d
Philipp72e43f02016-10-27 13:35:20 +02001511#define GSM48_MT_RR_HANDO_INFO 0x2d
1512#define GSM48_MT_RR_DTM_ASS_CMD 0x4c
Harald Welteec8b4502010-02-20 20:34:29 +01001513
1514#define GSM48_MT_RR_CELL_CHG_ORDER 0x08
1515#define GSM48_MT_RR_PDCH_ASS_CMD 0x23
1516
1517#define GSM48_MT_RR_CHAN_REL 0x0d
1518#define GSM48_MT_RR_PART_REL 0x0a
1519#define GSM48_MT_RR_PART_REL_COMP 0x0f
1520
1521#define GSM48_MT_RR_PAG_REQ_1 0x21
1522#define GSM48_MT_RR_PAG_REQ_2 0x22
1523#define GSM48_MT_RR_PAG_REQ_3 0x24
1524#define GSM48_MT_RR_PAG_RESP 0x27
1525#define GSM48_MT_RR_NOTIF_NCH 0x20
Philipp72e43f02016-10-27 13:35:20 +02001526#define GSM48_MT_RR_NOTIF_FACCH 0x25 /* (Reserved) */
Harald Welteec8b4502010-02-20 20:34:29 +01001527#define GSM48_MT_RR_NOTIF_RESP 0x26
Philipp72e43f02016-10-27 13:35:20 +02001528#define GSM48_MT_RR_PACKET_NOTIF 0x4e
Philipp349784c2016-10-10 15:03:23 +02001529#define GSM48_MT_RR_UTRAN_CLSM_CHG 0x60
1530#define GSM48_MT_RR_CDMA2K_CLSM_CHG 0x62
1531#define GSM48_MT_RR_IS_TO_UTRAN_HANDO 0x63
1532#define GSM48_MT_RR_IS_TO_CDMA2K_HANDO 0x64
1533
Harald Welteec8b4502010-02-20 20:34:29 +01001534#define GSM48_MT_RR_SYSINFO_8 0x18
1535#define GSM48_MT_RR_SYSINFO_1 0x19
1536#define GSM48_MT_RR_SYSINFO_2 0x1a
1537#define GSM48_MT_RR_SYSINFO_3 0x1b
1538#define GSM48_MT_RR_SYSINFO_4 0x1c
1539#define GSM48_MT_RR_SYSINFO_5 0x1d
1540#define GSM48_MT_RR_SYSINFO_6 0x1e
1541#define GSM48_MT_RR_SYSINFO_7 0x1f
1542
1543#define GSM48_MT_RR_SYSINFO_2bis 0x02
1544#define GSM48_MT_RR_SYSINFO_2ter 0x03
Maxe859aec2016-03-11 12:24:04 +01001545#define GSM48_MT_RR_SYSINFO_2quater 0x07
Harald Welteec8b4502010-02-20 20:34:29 +01001546#define GSM48_MT_RR_SYSINFO_5bis 0x05
1547#define GSM48_MT_RR_SYSINFO_5ter 0x06
1548#define GSM48_MT_RR_SYSINFO_9 0x04
1549#define GSM48_MT_RR_SYSINFO_13 0x00
1550
1551#define GSM48_MT_RR_SYSINFO_16 0x3d
1552#define GSM48_MT_RR_SYSINFO_17 0x3e
1553
Philipp72e43f02016-10-27 13:35:20 +02001554#define GSM48_MT_RR_SYSINFO_18 0x40
1555#define GSM48_MT_RR_SYSINFO_19 0x41
1556#define GSM48_MT_RR_SYSINFO_20 0x42
1557
Harald Welteec8b4502010-02-20 20:34:29 +01001558#define GSM48_MT_RR_CHAN_MODE_MODIF 0x10
1559#define GSM48_MT_RR_STATUS 0x12
1560#define GSM48_MT_RR_CHAN_MODE_MODIF_ACK 0x17
1561#define GSM48_MT_RR_FREQ_REDEF 0x14
1562#define GSM48_MT_RR_MEAS_REP 0x15
1563#define GSM48_MT_RR_CLSM_CHG 0x16
1564#define GSM48_MT_RR_CLSM_ENQ 0x13
1565#define GSM48_MT_RR_EXT_MEAS_REP 0x36
1566#define GSM48_MT_RR_EXT_MEAS_REP_ORD 0x37
1567#define GSM48_MT_RR_GPRS_SUSP_REQ 0x34
Philipp72e43f02016-10-27 13:35:20 +02001568#define GSM48_MT_RR_DTM_INFO 0x4d
Harald Welteec8b4502010-02-20 20:34:29 +01001569
Bhaskare6b45d82013-05-16 17:11:51 +05301570#define GSM48_MT_RR_VGCS_UPL_GRANT 0x09
Harald Welteec8b4502010-02-20 20:34:29 +01001571#define GSM48_MT_RR_UPLINK_RELEASE 0x0e
1572#define GSM48_MT_RR_UPLINK_FREE 0x0c
1573#define GSM48_MT_RR_UPLINK_BUSY 0x2a
1574#define GSM48_MT_RR_TALKER_IND 0x11
1575
1576#define GSM48_MT_RR_APP_INFO 0x38
1577
Max600d4ee2023-01-23 21:49:52 +03001578/* 3GPP TS 44.018 Table 10.4.2 */
1579#define GSM48_MT_RR_SH_SI10 0x0
1580#define GSM48_MT_RR_SH_FACCH 0x1
1581#define GSM48_MT_RR_SH_UL_FREE 0x2
1582#define GSM48_MT_RR_SH_MEAS_REP 0x4
1583#define GSM48_MT_RR_SH_MEAS_INFO 0x5
1584#define GSM48_MT_RR_SH_VGCS_RECON 0x6
1585#define GSM48_MT_RR_SH_VGCS_RECON2 0x7
1586#define GSM48_MT_RR_SH_VGCS_INFO 0x8
1587#define GSM48_MT_RR_SH_VGCS_SMS 0x9
1588#define GSM48_MT_RR_SH_SI10bis 0xA
1589#define GSM48_MT_RR_SH_SI10ter 0xB
1590#define GSM48_MT_RR_SH_VGCS_NEIGH 0xC
1591#define GSM48_MT_RR_SH_APP_DATA 0xD
1592
Harald Welteec8b4502010-02-20 20:34:29 +01001593/* Table 10.2/3GPP TS 04.08 */
1594#define GSM48_MT_MM_IMSI_DETACH_IND 0x01
1595#define GSM48_MT_MM_LOC_UPD_ACCEPT 0x02
1596#define GSM48_MT_MM_LOC_UPD_REJECT 0x04
1597#define GSM48_MT_MM_LOC_UPD_REQUEST 0x08
1598
1599#define GSM48_MT_MM_AUTH_REJ 0x11
1600#define GSM48_MT_MM_AUTH_REQ 0x12
1601#define GSM48_MT_MM_AUTH_RESP 0x14
Neels Hofmeyr55a43b82017-02-02 20:27:55 +01001602#define GSM48_MT_MM_AUTH_FAIL 0x1c
Harald Welteec8b4502010-02-20 20:34:29 +01001603#define GSM48_MT_MM_ID_REQ 0x18
1604#define GSM48_MT_MM_ID_RESP 0x19
1605#define GSM48_MT_MM_TMSI_REALL_CMD 0x1a
1606#define GSM48_MT_MM_TMSI_REALL_COMPL 0x1b
1607
1608#define GSM48_MT_MM_CM_SERV_ACC 0x21
1609#define GSM48_MT_MM_CM_SERV_REJ 0x22
1610#define GSM48_MT_MM_CM_SERV_ABORT 0x23
1611#define GSM48_MT_MM_CM_SERV_REQ 0x24
1612#define GSM48_MT_MM_CM_SERV_PROMPT 0x25
1613#define GSM48_MT_MM_CM_REEST_REQ 0x28
1614#define GSM48_MT_MM_ABORT 0x29
1615
1616#define GSM48_MT_MM_NULL 0x30
1617#define GSM48_MT_MM_STATUS 0x31
1618#define GSM48_MT_MM_INFO 0x32
1619
1620/* Table 10.3/3GPP TS 04.08 */
1621#define GSM48_MT_CC_ALERTING 0x01
1622#define GSM48_MT_CC_CALL_CONF 0x08
1623#define GSM48_MT_CC_CALL_PROC 0x02
1624#define GSM48_MT_CC_CONNECT 0x07
1625#define GSM48_MT_CC_CONNECT_ACK 0x0f
1626#define GSM48_MT_CC_EMERG_SETUP 0x0e
1627#define GSM48_MT_CC_PROGRESS 0x03
1628#define GSM48_MT_CC_ESTAB 0x04
1629#define GSM48_MT_CC_ESTAB_CONF 0x06
1630#define GSM48_MT_CC_RECALL 0x0b
1631#define GSM48_MT_CC_START_CC 0x09
1632#define GSM48_MT_CC_SETUP 0x05
1633
1634#define GSM48_MT_CC_MODIFY 0x17
1635#define GSM48_MT_CC_MODIFY_COMPL 0x1f
1636#define GSM48_MT_CC_MODIFY_REJECT 0x13
1637#define GSM48_MT_CC_USER_INFO 0x10
1638#define GSM48_MT_CC_HOLD 0x18
1639#define GSM48_MT_CC_HOLD_ACK 0x19
1640#define GSM48_MT_CC_HOLD_REJ 0x1a
1641#define GSM48_MT_CC_RETR 0x1c
1642#define GSM48_MT_CC_RETR_ACK 0x1d
1643#define GSM48_MT_CC_RETR_REJ 0x1e
1644
1645#define GSM48_MT_CC_DISCONNECT 0x25
1646#define GSM48_MT_CC_RELEASE 0x2d
1647#define GSM48_MT_CC_RELEASE_COMPL 0x2a
1648
1649#define GSM48_MT_CC_CONG_CTRL 0x39
1650#define GSM48_MT_CC_NOTIFY 0x3e
1651#define GSM48_MT_CC_STATUS 0x3d
1652#define GSM48_MT_CC_STATUS_ENQ 0x34
1653#define GSM48_MT_CC_START_DTMF 0x35
1654#define GSM48_MT_CC_STOP_DTMF 0x31
1655#define GSM48_MT_CC_STOP_DTMF_ACK 0x32
1656#define GSM48_MT_CC_START_DTMF_ACK 0x36
1657#define GSM48_MT_CC_START_DTMF_REJ 0x37
1658#define GSM48_MT_CC_FACILITY 0x3a
1659
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001660extern const struct value_string gsm48_rr_msgtype_names[];
1661extern const struct value_string gsm48_mm_msgtype_names[];
1662extern const struct value_string gsm48_cc_msgtype_names[];
1663const char *gsm48_pdisc_msgtype_name(uint8_t pdisc, uint8_t msg_type);
Harald Welte4a62eda2019-03-18 18:27:00 +01001664char *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 +01001665char *gsm48_pdisc_msgtype_name_c(const void *ctx, uint8_t pdisc, uint8_t msg_type);
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001666
Harald Welteec8b4502010-02-20 20:34:29 +01001667/* FIXME: Table 10.4 / 10.4a (GPRS) */
1668
Andreas Eversberg014cb872010-07-12 09:11:00 +02001669/* Section 10.5.3.3 CM service type */
Neels Hofmeyrf8963f92019-01-10 23:33:32 +01001670enum osmo_cm_service_type {
1671 GSM48_CMSERV_MO_CALL_PACKET = 1,
1672 GSM48_CMSERV_EMERGENCY = 2,
1673 GSM48_CMSERV_SMS = 4,
1674 GSM48_CMSERV_SUP_SERV = 8,
1675 GSM48_CMSERV_VGCS = 9,
1676 GSM48_CMSERV_VBS = 10,
1677 GSM48_CMSERV_LOC_SERV = 11,
1678 GSM48_CMSERV_MAX_VAL = GSM48_CMSERV_LOC_SERV
1679};
1680
1681extern const struct value_string osmo_cm_service_type_names[];
1682static inline const char *osmo_cm_service_type_name(enum osmo_cm_service_type val)
1683{ return get_value_string(osmo_cm_service_type_names, val); }
Andreas Eversberg014cb872010-07-12 09:11:00 +02001684
Harald Welteec8b4502010-02-20 20:34:29 +01001685/* Section 10.5.2.26, Table 10.5.64 */
1686#define GSM48_PM_MASK 0x03
1687#define GSM48_PM_NORMAL 0x00
1688#define GSM48_PM_EXTENDED 0x01
1689#define GSM48_PM_REORG 0x02
1690#define GSM48_PM_SAME 0x03
1691
1692/* Chapter 10.5.3.5 / Table 10.5.93 */
1693#define GSM48_LUPD_NORMAL 0x0
1694#define GSM48_LUPD_PERIODIC 0x1
1695#define GSM48_LUPD_IMSI_ATT 0x2
1696#define GSM48_LUPD_RESERVED 0x3
1697
Neels Hofmeyr92f3f5e2019-01-05 00:39:13 +01001698extern const struct value_string osmo_lu_type_names[];
1699static inline const char *osmo_lu_type_name(uint8_t lu_type)
1700{ return get_value_string(osmo_lu_type_names, lu_type); }
1701
Harald Welteec8b4502010-02-20 20:34:29 +01001702/* Table 10.5.4 */
1703#define GSM_MI_TYPE_MASK 0x07
1704#define GSM_MI_TYPE_NONE 0x00
1705#define GSM_MI_TYPE_IMSI 0x01
1706#define GSM_MI_TYPE_IMEI 0x02
1707#define GSM_MI_TYPE_IMEISV 0x03
1708#define GSM_MI_TYPE_TMSI 0x04
1709#define GSM_MI_ODD 0x08
1710
Andreas Eversberg014cb872010-07-12 09:11:00 +02001711#define GSM48_IE_MOBILE_ID 0x17 /* 10.5.1.4 */
Harald Welteec8b4502010-02-20 20:34:29 +01001712#define GSM48_IE_NAME_LONG 0x43 /* 10.5.3.5a */
1713#define GSM48_IE_NAME_SHORT 0x45 /* 10.5.3.5a */
1714#define GSM48_IE_UTC 0x46 /* 10.5.3.8 */
1715#define GSM48_IE_NET_TIME_TZ 0x47 /* 10.5.3.9 */
1716#define GSM48_IE_LSA_IDENT 0x48 /* 10.5.3.11 */
Jacob Erlbeck1c3f0882013-09-16 10:29:57 +02001717#define GSM48_IE_NET_DST 0x49 /* 10.5.3.12 [24.008] */
Harald Welteec8b4502010-02-20 20:34:29 +01001718
1719#define GSM48_IE_BEARER_CAP 0x04 /* 10.5.4.5 */
1720#define GSM48_IE_CAUSE 0x08 /* 10.5.4.11 */
1721#define GSM48_IE_CC_CAP 0x15 /* 10.5.4.5a */
1722#define GSM48_IE_ALERT 0x19 /* 10.5.4.26 */
1723#define GSM48_IE_FACILITY 0x1c /* 10.5.4.15 */
1724#define GSM48_IE_PROGR_IND 0x1e /* 10.5.4.21 */
1725#define GSM48_IE_AUX_STATUS 0x24 /* 10.5.4.4 */
1726#define GSM48_IE_NOTIFY 0x27 /* 10.5.4.20 */
1727#define GSM48_IE_KPD_FACILITY 0x2c /* 10.5.4.17 */
1728#define GSM48_IE_SIGNAL 0x34 /* 10.5.4.23 */
1729#define GSM48_IE_CONN_BCD 0x4c /* 10.5.4.13 */
1730#define GSM48_IE_CONN_SUB 0x4d /* 10.5.4.14 */
1731#define GSM48_IE_CALLING_BCD 0x5c /* 10.5.4.9 */
1732#define GSM48_IE_CALLING_SUB 0x5d /* 10.5.4.10 */
1733#define GSM48_IE_CALLED_BCD 0x5e /* 10.5.4.7 */
1734#define GSM48_IE_CALLED_SUB 0x6d /* 10.5.4.8 */
1735#define GSM48_IE_REDIR_BCD 0x74 /* 10.5.4.21a */
1736#define GSM48_IE_REDIR_SUB 0x75 /* 10.5.4.21b */
1737#define GSM48_IE_LOWL_COMPAT 0x7c /* 10.5.4.18 */
1738#define GSM48_IE_HIGHL_COMPAT 0x7d /* 10.5.4.16 */
1739#define GSM48_IE_USER_USER 0x7e /* 10.5.4.25 */
1740#define GSM48_IE_SS_VERS 0x7f /* 10.5.4.24 */
1741#define GSM48_IE_MORE_DATA 0xa0 /* 10.5.4.19 */
1742#define GSM48_IE_CLIR_SUPP 0xa1 /* 10.5.4.11a */
1743#define GSM48_IE_CLIR_INVOC 0xa2 /* 10.5.4.11b */
1744#define GSM48_IE_REV_C_SETUP 0xa3 /* 10.5.4.22a */
1745#define GSM48_IE_REPEAT_CIR 0xd1 /* 10.5.4.22 */
1746#define GSM48_IE_REPEAT_SEQ 0xd3 /* 10.5.4.22 */
1747
1748/* Section 10.5.4.11 / Table 10.5.122 */
1749#define GSM48_CAUSE_CS_GSM 0x60
1750
1751/* Section 9.1.2 / Table 9.3 */
Andreas Eversberg014cb872010-07-12 09:11:00 +02001752/* RR elements */
1753#define GSM48_IE_VGCS_TARGET 0x01
1754//#define GSM48_IE_VGCS_T_MODE_I 0x01
1755#define GSM48_IE_FRQSHORT_AFTER 0x02
1756#define GSM48_IE_MUL_RATE_CFG 0x03 /* 10.5.2.21aa */
1757#define GSM48_IE_FREQ_L_AFTER 0x05
Pau Espin Pedrol559a6ee2023-03-22 13:17:09 +01001758#define GSM48_IE_GROUP_CIP_SEQ_HO 0x08 /* HO = Half Octet Tag */
1759#define GSM48_IE_CIP_MODE_SET_HO 0x09 /* HO = Half Octet Tag */
1760#define GSM48_IE_GPRS_RESUMPT_HO 0xc0 /* HO = Half Octet Tag */
1761#define GSM48_IE_SYNC_IND_HO 0x0d /* HO = Half Octet Tag */
Harald Welteec8b4502010-02-20 20:34:29 +01001762#define GSM48_IE_MSLOT_DESC 0x10
Harald Welteec8b4502010-02-20 20:34:29 +01001763#define GSM48_IE_CHANMODE_2 0x11
Andreas Eversberg014cb872010-07-12 09:11:00 +02001764#define GSM48_IE_FRQSHORT_BEFORE 0x12
1765//#define GSM48_IE_FRQSHORT_BEFOR 0x12
Harald Welteec8b4502010-02-20 20:34:29 +01001766#define GSM48_IE_CHANMODE_3 0x13
1767#define GSM48_IE_CHANMODE_4 0x14
1768#define GSM48_IE_CHANMODE_5 0x15
1769#define GSM48_IE_CHANMODE_6 0x16
1770#define GSM48_IE_CHANMODE_7 0x17
1771#define GSM48_IE_CHANMODE_8 0x18
1772#define GSM48_IE_CHANDESC_2 0x64
Harald Welte639f74b2010-06-15 09:32:14 +02001773#define GSM48_IE_MA_AFTER 0x72
1774#define GSM48_IE_START_TIME 0x7c
1775#define GSM48_IE_FREQ_L_BEFORE 0x19
Andreas Eversberg014cb872010-07-12 09:11:00 +02001776//#define GSM48_IE_FRQLIST_BEFORE 0x19
Harald Welte639f74b2010-06-15 09:32:14 +02001777#define GSM48_IE_CH_DESC_1_BEFORE 0x1c
Andreas Eversberg014cb872010-07-12 09:11:00 +02001778//#define GSM48_IE_CHDES_1_BEFORE 0x1c
Harald Welte639f74b2010-06-15 09:32:14 +02001779#define GSM48_IE_CH_DESC_2_BEFORE 0x1d
Andreas Eversberg014cb872010-07-12 09:11:00 +02001780//#define GSM48_IE_CHDES_2_BEFORE 0x1d
Harald Welte639f74b2010-06-15 09:32:14 +02001781#define GSM48_IE_F_CH_SEQ_BEFORE 0x1e
Andreas Eversberg014cb872010-07-12 09:11:00 +02001782//#define GSM48_IE_FRQSEQ_BEFORE 0x1e
1783#define GSM48_IE_CLASSMARK3 0x20
Harald Welte639f74b2010-06-15 09:32:14 +02001784#define GSM48_IE_MA_BEFORE 0x21
Andreas Eversberg014cb872010-07-12 09:11:00 +02001785#define GSM48_IE_RR_PACKET_UL 0x22
1786#define GSM48_IE_RR_PACKET_DL 0x23
1787#define GSM48_IE_CELL_CH_DESC 0x62
1788#define GSM48_IE_CHANMODE_1 0x63
1789#define GSM48_IE_CHDES_2_AFTER 0x64
1790#define GSM48_IE_MODE_SEC_CH 0x66
1791#define GSM48_IE_F_CH_SEQ_AFTER 0x69
Neels Hofmeyr4b44ac42021-04-19 23:33:34 +02001792#define GSM48_IE_EXTENDED_TSC_SET 0x6d
Andreas Eversberg014cb872010-07-12 09:11:00 +02001793#define GSM48_IE_MA_AFTER 0x72
1794#define GSM48_IE_BA_RANGE 0x73
1795#define GSM48_IE_GROUP_CHDES 0x74
1796#define GSM48_IE_BA_LIST_PREF 0x75
1797#define GSM48_IE_MOB_OVSERV_DIF 0x77
Harald Weltecf2caeb2019-02-03 00:37:20 +01001798#define GSM48_IE_CELL_SEL_IND_AFTER_REL 0x77 /* 44.018 Section 9.1.7 */
Andreas Eversberg014cb872010-07-12 09:11:00 +02001799#define GSM48_IE_REALTIME_DIFF 0x7b
1800#define GSM48_IE_START_TIME 0x7c
Harald Weltecf2caeb2019-02-03 00:37:20 +01001801#define GSM48_IE_INDIVIDUAL_PRIORITIES 0x7c /* 44.018 Section 9.1.7 */
Andreas Eversberg014cb872010-07-12 09:11:00 +02001802#define GSM48_IE_TIMING_ADVANCE 0x7d
Pau Espin Pedrol559a6ee2023-03-22 13:17:09 +01001803#define GSM48_IE_GROUP_CIP_SEQ 0x80 /* DEPRECATED, use GSM48_IE_GROUP_CIP_SEQ_HO instead */
1804#define GSM48_IE_CIP_MODE_SET 0x90 /* DEPRECATED, use GSM48_IE_CIP_MODE_SET_HO instead */
1805#define GSM48_IE_GPRS_RESUMPT 0xc0 /* DEPRECATED, use GSM48_IE_GPRS_RESUMPT_HO instead */
1806#define GSM48_IE_SYNC_IND 0xd0 /* DEPRECATED, use GSM48_IE_SYNC_IND_HO instead */
Andreas Eversberg014cb872010-07-12 09:11:00 +02001807/* System Information 4 (types are equal IEs above) */
1808#define GSM48_IE_CBCH_CHAN_DESC 0x64
1809#define GSM48_IE_CBCH_MOB_AL 0x72
Harald Welte639f74b2010-06-15 09:32:14 +02001810
Andreas Eversberg014cb872010-07-12 09:11:00 +02001811/* Additional MM elements */
Pau Espin Pedrol559a6ee2023-03-22 13:17:09 +01001812#define GSM48_IE_PRIORITY_LEV_HO 0x08 /* HO = Half Octet Tag */
Andreas Eversberg014cb872010-07-12 09:11:00 +02001813#define GSM48_IE_LOCATION_AREA 0x13
Harald Welte82f94ef2016-05-05 23:33:27 +02001814#define GSM48_IE_AUTN 0x20
Neels Hofmeyr55a43b82017-02-02 20:27:55 +01001815#define GSM48_IE_AUTH_RES_EXT 0x21
1816#define GSM48_IE_AUTS 0x22
Pau Espin Pedrol559a6ee2023-03-22 13:17:09 +01001817#define GSM48_IE_PRIORITY_LEV 0x80 /* DEPRECATED, use GSM48_IE_PRIORITY_LEV_HO instead */
Andreas Eversberg014cb872010-07-12 09:11:00 +02001818#define GSM48_IE_FOLLOW_ON_PROC 0xa1
1819#define GSM48_IE_CTS_PERMISSION 0xa2
Harald Welteec8b4502010-02-20 20:34:29 +01001820
Keith05d32782018-05-28 14:08:10 +02001821/* Section 10.5.4.21 / Table 10.5.127 */
1822
1823enum gsm48_progress_desc {
1824 GSM48_PROGR_NOT_E2E = 0x00,
1825 GSM48_PROGR_DEST_NOT_PLMN = 0x02,
1826 GSM48_PROGR_ORIG_NOT_PLMN = 0x03,
1827 GSM48_PROGR_RETURNED = 0x04,
1828 GSM48_PROGR_IN_BAND_AVAIL = 0x08,
1829 GSM48_PROGR_CALL_E2E = 0x20,
1830 GSM48_PROGR_QUEUEING = 0x40,
1831};
1832
Harald Welteec8b4502010-02-20 20:34:29 +01001833/* Section 10.5.4.23 / Table 10.5.130 */
1834enum gsm48_signal_val {
1835 GSM48_SIGNAL_DIALTONE = 0x00,
1836 GSM48_SIGNAL_RINGBACK = 0x01,
1837 GSM48_SIGNAL_INTERCEPT = 0x02,
1838 GSM48_SIGNAL_NET_CONG = 0x03,
1839 GSM48_SIGNAL_BUSY = 0x04,
1840 GSM48_SIGNAL_CONFIRM = 0x05,
1841 GSM48_SIGNAL_ANSWER = 0x06,
1842 GSM48_SIGNAL_CALL_WAIT = 0x07,
1843 GSM48_SIGNAL_OFF_HOOK = 0x08,
1844 GSM48_SIGNAL_OFF = 0x3f,
1845 GSM48_SIGNAL_ALERT_OFF = 0x4f,
1846};
1847
Keithadfa1992018-05-25 15:24:06 +02001848/* Section 10.5.4.11 / Table 10.5.122 */
1849enum gsm48_cause_coding {
1850 GSM48_CAUSE_CODING_CCITT_Q931 = 0x00,
1851 GSM48_CAUSE_CODING_RESERVED = 0x01,
1852 GSM48_CAUSE_CODING_NATIONAL = 0x02,
1853 GSM48_CAUSE_CODING_GSM = 0x03,
1854};
1855
Harald Welteec8b4502010-02-20 20:34:29 +01001856enum gsm48_cause_loc {
1857 GSM48_CAUSE_LOC_USER = 0x00,
1858 GSM48_CAUSE_LOC_PRN_S_LU = 0x01,
1859 GSM48_CAUSE_LOC_PUN_S_LU = 0x02,
1860 GSM48_CAUSE_LOC_TRANS_NET = 0x03,
1861 GSM48_CAUSE_LOC_PUN_S_RU = 0x04,
1862 GSM48_CAUSE_LOC_PRN_S_RU = 0x05,
1863 /* not defined */
1864 GSM48_CAUSE_LOC_INN_NET = 0x07,
1865 GSM48_CAUSE_LOC_NET_BEYOND = 0x0a,
1866};
1867
Neels Hofmeyr6ad50aa2019-01-14 20:28:56 +01001868/* 3GPP TS 44.018 10.5.2.31 RR Cause / Table 10.5.70 */
Harald Welteec8b4502010-02-20 20:34:29 +01001869enum gsm48_rr_cause {
1870 GSM48_RR_CAUSE_NORMAL = 0x00,
1871 GSM48_RR_CAUSE_ABNORMAL_UNSPEC = 0x01,
1872 GSM48_RR_CAUSE_ABNORMAL_UNACCT = 0x02,
1873 GSM48_RR_CAUSE_ABNORMAL_TIMER = 0x03,
1874 GSM48_RR_CAUSE_ABNORMAL_NOACT = 0x04,
1875 GSM48_RR_CAUSE_PREMPTIVE_REL = 0x05,
Vadim Yanitskiyf5f0d432020-10-29 18:21:53 +07001876 GSM48_RR_CAUSE_UTRAN_CFG_UNK = 0x06,
Andreas Eversbergc8cac642013-06-19 20:58:59 +02001877 GSM48_RR_CAUSE_HNDOVER_IMP = 0x08,
1878 GSM48_RR_CAUSE_CHAN_MODE_UNACCT = 0x09,
1879 GSM48_RR_CAUSE_FREQ_NOT_IMPL = 0x0a,
Vadim Yanitskiyf5f0d432020-10-29 18:21:53 +07001880 GSM48_RR_CAUSE_LEAVE_GROUP_CA = 0x0b,
1881 GSM48_RR_CAUSE_LOW_LEVEL_FAIL = 0x0c,
Harald Welteec8b4502010-02-20 20:34:29 +01001882 GSM48_RR_CAUSE_CALL_CLEARED = 0x41,
1883 GSM48_RR_CAUSE_SEMANT_INCORR = 0x5f,
1884 GSM48_RR_CAUSE_INVALID_MAND_INF = 0x60,
1885 GSM48_RR_CAUSE_MSG_TYPE_N = 0x61,
1886 GSM48_RR_CAUSE_MSG_TYPE_N_COMPAT= 0x62,
1887 GSM48_RR_CAUSE_COND_IE_ERROR = 0x64,
1888 GSM48_RR_CAUSE_NO_CELL_ALLOC_A = 0x65,
1889 GSM48_RR_CAUSE_PROT_ERROR_UNSPC = 0x6f,
1890};
1891
1892/* Section 10.5.4.11 CC Cause / Table 10.5.123 */
1893enum gsm48_cc_cause {
1894 GSM48_CC_CAUSE_UNASSIGNED_NR = 1,
1895 GSM48_CC_CAUSE_NO_ROUTE = 3,
1896 GSM48_CC_CAUSE_CHAN_UNACCEPT = 6,
1897 GSM48_CC_CAUSE_OP_DET_BARRING = 8,
1898 GSM48_CC_CAUSE_NORM_CALL_CLEAR = 16,
1899 GSM48_CC_CAUSE_USER_BUSY = 17,
1900 GSM48_CC_CAUSE_USER_NOTRESPOND = 18,
1901 GSM48_CC_CAUSE_USER_ALERTING_NA = 19,
1902 GSM48_CC_CAUSE_CALL_REJECTED = 21,
1903 GSM48_CC_CAUSE_NUMBER_CHANGED = 22,
1904 GSM48_CC_CAUSE_PRE_EMPTION = 25,
1905 GSM48_CC_CAUSE_NONSE_USER_CLR = 26,
1906 GSM48_CC_CAUSE_DEST_OOO = 27,
1907 GSM48_CC_CAUSE_INV_NR_FORMAT = 28,
1908 GSM48_CC_CAUSE_FACILITY_REJ = 29,
1909 GSM48_CC_CAUSE_RESP_STATUS_INQ = 30,
1910 GSM48_CC_CAUSE_NORMAL_UNSPEC = 31,
1911 GSM48_CC_CAUSE_NO_CIRCUIT_CHAN = 34,
1912 GSM48_CC_CAUSE_NETWORK_OOO = 38,
1913 GSM48_CC_CAUSE_TEMP_FAILURE = 41,
1914 GSM48_CC_CAUSE_SWITCH_CONG = 42,
1915 GSM48_CC_CAUSE_ACC_INF_DISCARD = 43,
1916 GSM48_CC_CAUSE_REQ_CHAN_UNAVAIL = 44,
1917 GSM48_CC_CAUSE_RESOURCE_UNAVAIL = 47,
1918 GSM48_CC_CAUSE_QOS_UNAVAIL = 49,
1919 GSM48_CC_CAUSE_REQ_FAC_NOT_SUBSC= 50,
1920 GSM48_CC_CAUSE_INC_BARRED_CUG = 55,
1921 GSM48_CC_CAUSE_BEARER_CAP_UNAUTH= 57,
1922 GSM48_CC_CAUSE_BEARER_CA_UNAVAIL= 58,
1923 GSM48_CC_CAUSE_SERV_OPT_UNAVAIL = 63,
1924 GSM48_CC_CAUSE_BEARERSERV_UNIMPL= 65,
1925 GSM48_CC_CAUSE_ACM_GE_ACM_MAX = 68,
1926 GSM48_CC_CAUSE_REQ_FAC_NOTIMPL = 69,
1927 GSM48_CC_CAUSE_RESTR_BCAP_AVAIL = 70,
1928 GSM48_CC_CAUSE_SERV_OPT_UNIMPL = 79,
1929 GSM48_CC_CAUSE_INVAL_TRANS_ID = 81,
1930 GSM48_CC_CAUSE_USER_NOT_IN_CUG = 87,
1931 GSM48_CC_CAUSE_INCOMPAT_DEST = 88,
1932 GSM48_CC_CAUSE_INVAL_TRANS_NET = 91,
1933 GSM48_CC_CAUSE_SEMANTIC_INCORR = 95,
1934 GSM48_CC_CAUSE_INVAL_MAND_INF = 96,
1935 GSM48_CC_CAUSE_MSGTYPE_NOTEXIST = 97,
1936 GSM48_CC_CAUSE_MSGTYPE_INCOMPAT = 98,
1937 GSM48_CC_CAUSE_IE_NOTEXIST = 99,
1938 GSM48_CC_CAUSE_COND_IE_ERR = 100,
1939 GSM48_CC_CAUSE_MSG_INCOMP_STATE = 101,
1940 GSM48_CC_CAUSE_RECOVERY_TIMER = 102,
1941 GSM48_CC_CAUSE_PROTO_ERR = 111,
1942 GSM48_CC_CAUSE_INTERWORKING = 127,
1943};
1944
Keith3cdaa8d2018-08-31 20:09:18 +02001945extern const struct value_string gsm48_cc_cause_names[];
1946static inline const char *gsm48_cc_cause_name(enum gsm48_cc_cause val)
1947{ return get_value_string(gsm48_cc_cause_names, val); }
1948
Harald Welteec8b4502010-02-20 20:34:29 +01001949/* Annex G, GSM specific cause values for mobility management */
1950enum gsm48_reject_value {
1951 GSM48_REJECT_IMSI_UNKNOWN_IN_HLR = 2,
1952 GSM48_REJECT_ILLEGAL_MS = 3,
1953 GSM48_REJECT_IMSI_UNKNOWN_IN_VLR = 4,
1954 GSM48_REJECT_IMEI_NOT_ACCEPTED = 5,
1955 GSM48_REJECT_ILLEGAL_ME = 6,
1956 GSM48_REJECT_PLMN_NOT_ALLOWED = 11,
1957 GSM48_REJECT_LOC_NOT_ALLOWED = 12,
1958 GSM48_REJECT_ROAMING_NOT_ALLOWED = 13,
1959 GSM48_REJECT_NETWORK_FAILURE = 17,
Neels Hofmeyr55a43b82017-02-02 20:27:55 +01001960 GSM48_REJECT_SYNCH_FAILURE = 21,
Harald Welteec8b4502010-02-20 20:34:29 +01001961 GSM48_REJECT_CONGESTION = 22,
1962 GSM48_REJECT_SRV_OPT_NOT_SUPPORTED = 32,
1963 GSM48_REJECT_RQD_SRV_OPT_NOT_SUPPORTED = 33,
1964 GSM48_REJECT_SRV_OPT_TMP_OUT_OF_ORDER = 34,
1965 GSM48_REJECT_CALL_CAN_NOT_BE_IDENTIFIED = 38,
1966 GSM48_REJECT_INCORRECT_MESSAGE = 95,
1967 GSM48_REJECT_INVALID_MANDANTORY_INF = 96,
1968 GSM48_REJECT_MSG_TYPE_NOT_IMPLEMENTED = 97,
1969 GSM48_REJECT_MSG_TYPE_NOT_COMPATIBLE = 98,
1970 GSM48_REJECT_INF_ELEME_NOT_IMPLEMENTED = 99,
1971 GSM48_REJECT_CONDTIONAL_IE_ERROR = 100,
1972 GSM48_REJECT_MSG_NOT_COMPATIBLE = 101,
1973 GSM48_REJECT_PROTOCOL_ERROR = 111,
1974
1975 /* according to G.6 Additional cause codes for GMM */
1976 GSM48_REJECT_GPRS_NOT_ALLOWED = 7,
1977 GSM48_REJECT_SERVICES_NOT_ALLOWED = 8,
1978 GSM48_REJECT_MS_IDENTITY_NOT_DERVIVABLE = 9,
1979 GSM48_REJECT_IMPLICITLY_DETACHED = 10,
1980 GSM48_REJECT_GPRS_NOT_ALLOWED_IN_PLMN = 14,
1981 GSM48_REJECT_MSC_TMP_NOT_REACHABLE = 16,
1982};
1983
Neels Hofmeyraead2412018-04-06 04:31:00 +02001984extern const struct value_string gsm48_reject_value_names[];
1985static inline const char *gsm48_reject_value_name(enum gsm48_reject_value val)
1986{ return get_value_string(gsm48_reject_value_names, val); }
1987
Harald Welteec8b4502010-02-20 20:34:29 +01001988enum chreq_type {
1989 CHREQ_T_EMERG_CALL,
1990 CHREQ_T_CALL_REEST_TCH_F,
1991 CHREQ_T_CALL_REEST_TCH_H,
1992 CHREQ_T_CALL_REEST_TCH_H_DBL,
1993 CHREQ_T_SDCCH,
1994 CHREQ_T_TCH_F,
1995 CHREQ_T_VOICE_CALL_TCH_H,
1996 CHREQ_T_DATA_CALL_TCH_H,
1997 CHREQ_T_LOCATION_UPD,
1998 CHREQ_T_PAG_R_ANY_NECI0,
1999 CHREQ_T_PAG_R_ANY_NECI1,
2000 CHREQ_T_PAG_R_TCH_F,
2001 CHREQ_T_PAG_R_TCH_FH,
2002 CHREQ_T_LMU,
2003 CHREQ_T_RESERVED_SDCCH,
2004 CHREQ_T_RESERVED_IGNORE,
Alexander Couzensf48e8a82016-12-05 15:57:42 +01002005 CHREQ_T_PDCH_ONE_PHASE,
2006 CHREQ_T_PDCH_TWO_PHASE,
Alexander Couzens953f9292017-03-14 13:47:29 +01002007 _NUM_CHREQ_T,
Harald Welteec8b4502010-02-20 20:34:29 +01002008};
2009
2010/* Chapter 11.3 */
2011#define GSM48_T301 180, 0
2012#define GSM48_T303 30, 0
2013#define GSM48_T305 30, 0
2014#define GSM48_T306 30, 0
Harald Weltee50b0092018-01-27 09:40:34 +01002015#define GSM48_T308 10, 0 /* no spec default */
Harald Weltecd827102018-01-27 09:43:03 +01002016#define GSM48_T310 30, 0 /* no spec default */
Harald Weltee50b0092018-01-27 09:40:34 +01002017#define GSM48_T313 30, 0 /* no spec default */
Harald Welteec8b4502010-02-20 20:34:29 +01002018#define GSM48_T323 30, 0
Harald Weltee50b0092018-01-27 09:40:34 +01002019#define GSM48_T331 30, 0 /* no spec default */
2020#define GSM48_T333 30, 0 /* no spec default */
2021#define GSM48_T334 25, 0 /* min 15s */
2022#define GSM48_T338 30, 0 /* no spec default */
Andreas Eversberg014cb872010-07-12 09:11:00 +02002023#define GSM48_T303_MS 30, 0
2024#define GSM48_T305_MS 30, 0
2025#define GSM48_T308_MS 30, 0
2026#define GSM48_T310_MS 30, 0
2027#define GSM48_T313_MS 30, 0
2028#define GSM48_T323_MS 30, 0
2029#define GSM48_T332_MS 30, 0
2030#define GSM48_T335_MS 30, 0
Harald Welteec8b4502010-02-20 20:34:29 +01002031
2032/* Chapter 5.1.2.2 */
2033#define GSM_CSTATE_NULL 0
2034#define GSM_CSTATE_INITIATED 1
Andreas Eversberg1ef041f2010-04-09 07:52:12 +02002035#define GSM_CSTATE_MM_CONNECTION_PEND 2 /* see 10.5.4.6 */
Harald Welteec8b4502010-02-20 20:34:29 +01002036#define GSM_CSTATE_MO_CALL_PROC 3
2037#define GSM_CSTATE_CALL_DELIVERED 4
2038#define GSM_CSTATE_CALL_PRESENT 6
2039#define GSM_CSTATE_CALL_RECEIVED 7
2040#define GSM_CSTATE_CONNECT_REQUEST 8
2041#define GSM_CSTATE_MO_TERM_CALL_CONF 9
2042#define GSM_CSTATE_ACTIVE 10
2043#define GSM_CSTATE_DISCONNECT_REQ 12
2044#define GSM_CSTATE_DISCONNECT_IND 12
2045#define GSM_CSTATE_RELEASE_REQ 19
2046#define GSM_CSTATE_MO_ORIG_MODIFY 26
2047#define GSM_CSTATE_MO_TERM_MODIFY 27
2048#define GSM_CSTATE_CONNECT_IND 28
2049
2050#define SBIT(a) (1 << a)
2051#define ALL_STATES 0xffffffff
2052
2053/* Table 10.5.3/3GPP TS 04.08: Location Area Identification information element */
2054#define GSM_LAC_RESERVED_DETACHED 0x0
2055#define GSM_LAC_RESERVED_ALL_BTS 0xfffe
2056
2057/* GSM 04.08 Bearer Capability: Information Transfer Capability */
2058enum gsm48_bcap_itcap {
2059 GSM48_BCAP_ITCAP_SPEECH = 0,
2060 GSM48_BCAP_ITCAP_UNR_DIG_INF = 1,
2061 GSM48_BCAP_ITCAP_3k1_AUDIO = 2,
2062 GSM48_BCAP_ITCAP_FAX_G3 = 3,
2063 GSM48_BCAP_ITCAP_OTHER = 5,
2064 GSM48_BCAP_ITCAP_RESERVED = 7,
2065};
2066
2067/* GSM 04.08 Bearer Capability: Transfer Mode */
2068enum gsm48_bcap_tmod {
2069 GSM48_BCAP_TMOD_CIRCUIT = 0,
2070 GSM48_BCAP_TMOD_PACKET = 1,
2071};
2072
2073/* GSM 04.08 Bearer Capability: Coding Standard */
2074enum gsm48_bcap_coding {
2075 GSM48_BCAP_CODING_GSM_STD = 0,
2076};
2077
2078/* GSM 04.08 Bearer Capability: Radio Channel Requirements */
2079enum gsm48_bcap_rrq {
2080 GSM48_BCAP_RRQ_FR_ONLY = 1,
2081 GSM48_BCAP_RRQ_DUAL_HR = 2,
2082 GSM48_BCAP_RRQ_DUAL_FR = 3,
2083};
2084
Harald Weltec8a0b932012-08-24 21:27:26 +02002085/* GSM 04.08 Bearer Capability: Rate Adaption */
2086enum gsm48_bcap_ra {
2087 GSM48_BCAP_RA_NONE = 0,
2088 GSM48_BCAP_RA_V110_X30 = 1,
2089 GSM48_BCAP_RA_X31 = 2,
2090 GSM48_BCAP_RA_OTHER = 3,
2091};
2092
2093/* GSM 04.08 Bearer Capability: Signalling access protocol */
2094enum gsm48_bcap_sig_access {
2095 GSM48_BCAP_SA_I440_I450 = 1,
2096 GSM48_BCAP_SA_X21 = 2,
2097 GSM48_BCAP_SA_X28_DP_IN = 3,
2098 GSM48_BCAP_SA_X28_DP_UN = 4,
2099 GSM48_BCAP_SA_X28_NDP = 5,
2100 GSM48_BCAP_SA_X32 = 6,
2101};
2102
2103/* GSM 04.08 Bearer Capability: User Rate */
2104enum gsm48_bcap_user_rate {
2105 GSM48_BCAP_UR_300 = 1,
2106 GSM48_BCAP_UR_1200 = 2,
2107 GSM48_BCAP_UR_2400 = 3,
2108 GSM48_BCAP_UR_4800 = 4,
2109 GSM48_BCAP_UR_9600 = 5,
2110 GSM48_BCAP_UR_12000 = 6,
2111 GSM48_BCAP_UR_1200_75 = 7,
2112};
2113
2114/* GSM 04.08 Bearer Capability: Parity */
2115enum gsm48_bcap_parity {
2116 GSM48_BCAP_PAR_ODD = 0,
2117 GSM48_BCAP_PAR_EVEN = 2,
2118 GSM48_BCAP_PAR_NONE = 3,
2119 GSM48_BCAP_PAR_ZERO = 4,
2120 GSM48_BCAP_PAR_ONE = 5,
2121};
2122
2123/* GSM 04.08 Bearer Capability: Intermediate Rate */
2124enum gsm48_bcap_interm_rate {
2125 GSM48_BCAP_IR_8k = 2,
2126 GSM48_BCAP_IR_16k = 3,
2127};
2128
2129/* GSM 04.08 Bearer Capability: Transparency */
2130enum gsm48_bcap_transp {
2131 GSM48_BCAP_TR_TRANSP = 0,
2132 GSM48_BCAP_TR_RLP = 1,
2133 GSM48_BCAP_TR_TR_PREF = 2,
2134 GSM48_BCAP_TR_RLP_PREF = 3,
2135};
2136
2137/* GSM 04.08 Bearer Capability: Modem Type */
2138enum gsm48_bcap_modem_type {
2139 GSM48_BCAP_MT_NONE = 0,
2140 GSM48_BCAP_MT_V21 = 1,
2141 GSM48_BCAP_MT_V22 = 2,
2142 GSM48_BCAP_MT_V22bis = 3,
2143 GSM48_BCAP_MT_V23 = 4,
2144 GSM48_BCAP_MT_V26ter = 5,
2145 GSM48_BCAP_MT_V32 = 6,
2146 GSM48_BCAP_MT_UNDEF = 7,
2147 GSM48_BCAP_MT_AUTO_1 = 8,
2148};
2149
Neels Hofmeyr87e45502017-06-20 00:17:59 +02002150/*! GSM 04.08 Bearer Capability: Speech Version Indication
Philipp Maier3d9191e2017-05-31 17:22:03 +02002151 * (See also 3GPP TS 24.008, Table 10.5.103) */
Harald Welte30a8ec42012-08-24 23:00:05 +02002152enum gsm48_bcap_speech_ver {
Philipp Maiera9e193b2017-06-16 16:47:06 +02002153 GSM48_BCAP_SV_FR = 0, /*!< GSM FR V1 (GSM FR) */
2154 GSM48_BCAP_SV_HR = 1, /*!< GSM HR V1 (GSM HR) */
2155 GSM48_BCAP_SV_EFR = 2, /*!< GSM FR V2 (GSM EFR) */
2156 GSM48_BCAP_SV_AMR_F = 4, /*!< GSM FR V3 (FR AMR) */
2157 GSM48_BCAP_SV_AMR_H = 5, /*!< GSM HR V3 (HR_AMR) */
Philipp Maier3d9191e2017-05-31 17:22:03 +02002158 GSM48_BCAP_SV_AMR_OFW = 6, /*!< GSM FR V4 (OFR AMR-WB) */
2159 GSM48_BCAP_SV_AMR_OHW = 7, /*!< GSM HR V4 (OHR AMR-WB) */
2160 GSM48_BCAP_SV_AMR_FW = 8, /*!< GSM FR V5 (FR AMR-WB) */
2161 GSM48_BCAP_SV_AMR_OH = 11, /*!< GSM HR V6 (OHR AMR) */
Harald Welte30a8ec42012-08-24 23:00:05 +02002162};
2163
Harald Welteec8b4502010-02-20 20:34:29 +01002164#define GSM48_TMSI_LEN 5
2165#define GSM48_MID_TMSI_LEN (GSM48_TMSI_LEN + 2)
2166#define GSM48_MI_SIZE 32
2167
Maxff2eeda2018-01-04 18:43:44 +01002168/* 3GPP TS 24.008 ยง 10.5.5.15 Routing area identification */
Harald Weltea1c4f762010-05-01 11:59:42 +02002169struct gsm48_ra_id {
2170 uint8_t digits[3]; /* MCC + MNC BCD digits */
2171 uint16_t lac; /* Location Area Code */
2172 uint8_t rac; /* Routing Area Code */
2173} __attribute__ ((packed));
2174
Harald Welteb5503132011-05-24 15:01:53 +02002175#define GSM48_CELL_CHAN_DESC_SIZE 16
Harald Weltea1c4f762010-05-01 11:59:42 +02002176
Harald Welteb5503132011-05-24 15:01:53 +02002177#define GSM_MACBLOCK_LEN 23
2178#define GSM_MACBLOCK_PADDING 0x2b
Harald Welte55478082018-02-09 22:39:29 +01002179
2180/* Table 10.5.118 / 3GPP TS 24.008 Section 10.5.4.7 */
2181enum gsm48_type_of_number {
2182 GSM48_TON_UNKNOWN = 0,
2183 GSM48_TON_INTERNATIONAL = 1,
2184 GSM48_TON_NATIONAL = 2,
2185 GSM48_TON_NET_SPEC = 3,
2186 GSM48_TON_SHORT_CODE = 4,
2187 /* reserved */
2188};
2189
2190/* Table 10.5.118 / 3GPP TS 24.008 Section 10.5.4.7 */
2191enum gsm48_numbering_plan {
2192 GSM48_NPI_UNKNOWN = 0,
2193 GSM48_NPI_ISDN_E164 = 1,
2194 GSM48_NPI_DATA_X121 = 3,
2195 GSM48_NPI_TELEX_F69 = 4,
2196 GSM48_NPI_NATIONAL = 8,
2197 GSM48_NPI_PRIVATE = 9,
2198 GSM48_NPI_CTS = 11,
2199 /* reserved */
2200};