blob: b4aff10a3b08a1ecf5d5d6d7d474ef0d6d001032 [file] [log] [blame]
Harald Welte9419c8a2017-07-30 04:07:05 +02001/* Encoding/Decoding routines for GSM System Information messages
Harald Welte34b5a952019-05-27 11:54:11 +02002 * according to 3GPP TS 44.018 Version 12.3.0 Release 12
3 *
4 * (C) 2017-2019 Harald Welte <laforge@gnumonks.org>
5 * All rights reserved.
6 *
7 * Released under the terms of GNU General Public License, Version 2 or
8 * (at your option) any later version.
9 *
10 * SPDX-License-Identifier: GPL-2.0-or-later
11 */
Harald Welte9419c8a2017-07-30 04:07:05 +020012
13module GSM_RR_Types {
14
15 import from General_Types all;
16 import from Osmocom_Types all;
17 import from GSM_Types all;
18 import from RLCMAC_CSN1_Types all;
Vadim Yanitskiy98bb2d52020-03-28 00:57:21 +070019 import from MobileL3_CommonIE_Types all;
Vadim Yanitskiy27b38012020-09-01 05:14:46 +070020 import from MobileL3_RRM_Types all;
Harald Welte9419c8a2017-07-30 04:07:05 +020021
22 /* Table 10.4.1 of Section 10.4 / 3GPP TS 44.018 */
23 type enumerated RrMessageType {
24 ADDITIONAL_ASSIGNMENT ('00111011'B),
25 IMMEDIATE_ASSIGNMENT ('00111111'B),
26 IMMEDIATE_ASSIGNMENT_EXTENDED ('00111001'B),
27 IMMEDIATE_ASSIGNMENT_REJECT ('00111010'B),
28 IMMEDIATE_PACKET_ASSIGNMENT ('01101001'B),
29
30 CIPHERING_MODE_COMMAND ('00110101'B),
31 CIPHERING_MODE_COMPLETE ('00110010'B),
32
33 CONFIGURATION_CHANGE_COMMAND ('00110000'B),
34 CONFIGURATION_CHANGE_ACK ('00110001'B),
35 CONFIGURATION_CHANGE_REJECT ('00110011'B),
36
37 ASSIGNMENT_COMMAND ('00101110'B),
38 ASSIGNMENT_COMPLETE ('00101001'B),
39 ASSIGNMENT_FAILURE ('00101111'B),
40 HANDOVER_COMMAND ('00101011'B),
41 HANDOVER_COMPLETE ('00101100'B),
42 HANDOVER_FAILURE ('00101000'B),
43 PHYSICAL_INFORMATION ('00101101'B),
44
45 CHANNEL_RELEASE ('00001101'B),
46 PARTIAL_RELEASE ('00001010'B),
47 PARTIAL_RELEASE_COMPLETE ('00001111'B),
48
49 PAGING_REQUEST_TYPE_1 ('00100001'B),
50 PAGING_REQUEST_TYPE_2 ('00100010'B),
51 PAGING_REQUEST_TYPE_3 ('00100100'B),
52 PAGING_RESPONSE ('00100111'B),
53 NOTIFICATION_NCH ('00100000'B),
54 NOTIFICATION_RESPOSNE ('00100110'B),
55
56 SYSTEM_INFORMATION_TYPE_8 ('00011000'B),
57 SYSTEM_INFORMATION_TYPE_1 ('00011001'B),
58 SYSTEM_INFORMATION_TYPE_2 ('00011010'B),
59 SYSTEM_INFORMATION_TYPE_3 ('00011011'B),
60 SYSTEM_INFORMATION_TYPE_4 ('00011100'B),
61 SYSTEM_INFORMATION_TYPE_5 ('00011101'B),
62 SYSTEM_INFORMATION_TYPE_6 ('00011110'B),
63 SYSTEM_INFORMATION_TYPE_7 ('00011111'B),
64 SYSTEM_INFORMATION_TYPE_2bis ('00000010'B),
65 SYSTEM_INFORMATION_TYPE_2ter ('00000011'B),
66 SYSTEM_INFORMATION_TYPE_2quater ('00000111'B),
67 SYSTEM_INFORMATION_TYPE_5bis ('00000101'B),
68 SYSTEM_INFORMATION_TYPE_5ter ('00000110'B),
69 SYSTEM_INFORMATION_TYPE_9 ('00000100'B),
70 SYSTEM_INFORMATION_TYPE_13 ('00000000'B),
71
72 SYSTEM_INFORMATION_TYPE_16 ('00111101'B),
73 SYSTEM_INFORMATION_TYPE_17 ('00111110'B),
74
75 CHANNEL_MODE_MODIFY ('00010000'B),
76 RR_STATUS ('00010010'B),
77 CHANNEL_MODE_MODIFY_ACKNOWLEDGE ('00010111'B),
78 FREQUENCY_REDEFINITION ('00010100'B),
79 MEASUREMENT_REPORT ('00010101'B),
80 CLASSMARK_CHANGE ('00010110'B),
81 CLASSMARK_ENQUIRY ('00010011'B),
82 EXTENDED_MEASUREMENT_REPORT ('00110110'B),
83 EXTENDED_MEASUREMENT_ORDER ('00110111'B),
84 GPRS_SUSPENSION_REQUEST ('00110100'B),
85 //MBMS_ANNOUNCEMENT ('00010110'B), duplicate?
86 //SERVICE_INFORMATION ('00110110'B), duplicate?
87
88 APPLICATION_INFORMATION ('00111000'B),
89
90 SYSTEM_INFORMATION_TYPE_14 ('00000001'B),
91 SYSTEM_INFORMATION_TYPE_15 ('01000011'B),
92 SYSTEM_INFORMATION_TYPE_18 ('01000000'B),
93 SYSTEM_INFORMATION_TYPE_19 ('01000001'B),
94 SYSTEM_INFORMATION_TYPE_20 ('01000010'B),
95 SYSTEM_INFORMATION_TYPE_13alt ('01000100'B),
96 SYSTEM_INFORMATION_TYPE_2n ('01000101'B),
97 SYSTEM_INFORMATION_TYPE_21 ('01000110'B),
98 SYSTEM_INFORMATION_TYPE_22 ('01000111'B),
99 SYSTEM_INFORMATION_TYPE_23 ('01001111'B),
100
101 DTM_ASSIGNMENT_FAILURE ('01001000'B),
102 DTM_REJECT ('01001001'B),
103 DTM_REQUEST ('01001010'B),
104 PACKET_ASSIGNMENT ('01001011'B),
105 DTM_ASSIGNMENT_COMMAND ('01001100'B),
106 DTM_INFORMATION ('01001101'B),
107 PACKET_INFORMATION ('01001110'B),
108
109 UTRAN_CLASSMARK_CHANGE ('01100000'B),
110 CDMA2000_CLASSMARK_CHANGE ('01100010'B),
111 INTERSYS_TO_UTRAN_HO_CMD ('01100011'B),
112 INTERSYS_TO_CDMA2000_HO_CMD ('01100100'B),
113 GERAN_IU_MODE_CLASSMARK_CHG ('01100101'B),
114 INTERSYS_TO_EUTRAN_HO_CMD ('01100110'B)
115 } with { variant "FIELDLENGTH(8)" };
116
Neels Hofmeyr95a5edc2020-07-11 02:57:04 +0200117 type enumerated RR_Cause {
118 GSM48_RR_CAUSE_NORMAL ('00'O),
119 GSM48_RR_CAUSE_ABNORMAL_UNSPEC ('01'O),
120 GSM48_RR_CAUSE_ABNORMAL_UNACCT ('02'O),
121 GSM48_RR_CAUSE_ABNORMAL_TIMER ('03'O),
122 GSM48_RR_CAUSE_ABNORMAL_NOACT ('04'O),
123 GSM48_RR_CAUSE_PREMPTIVE_REL ('05'O),
124 GSM48_RR_CAUSE_HNDOVER_IMP ('08'O),
125 GSM48_RR_CAUSE_CHAN_MODE_UNACCT ('09'O),
126 GSM48_RR_CAUSE_FREQ_NOT_IMPL ('0a'O),
127 GSM48_RR_CAUSE_CALL_CLEARED ('41'O),
128 GSM48_RR_CAUSE_SEMANT_INCORR ('5f'O),
129 GSM48_RR_CAUSE_INVALID_MAND_INF ('60'O),
130 GSM48_RR_CAUSE_MSG_TYPE_N ('61'O),
131 GSM48_RR_CAUSE_MSG_TYPE_N_COMPAT('62'O),
132 GSM48_RR_CAUSE_COND_IE_ERROR ('64'O),
133 GSM48_RR_CAUSE_NO_CELL_ALLOC_A ('65'O),
134 GSM48_RR_CAUSE_PROT_ERROR_UNSPC ('6f'O)
135 } with { variant "FIELDLENGTH(8)" };
136
Harald Welte9419c8a2017-07-30 04:07:05 +0200137 type octetstring RestOctets with { variant "PADDING(yes), PADDING_PATTERN('00101011'B)" };
Harald Welte9419c8a2017-07-30 04:07:05 +0200138
139 type record L2PseudoLength {
140 uint6_t l2_plen,
141 BIT2 zero_one
142 } with { variant "" };
143
Harald Weltef8df4cb2018-03-10 15:15:08 +0100144 template L2PseudoLength tr_L2Pseudolength(template uint6_t len) := {
145 l2_plen := len,
146 zero_one := '01'B
147 };
148
149 template (value) L2PseudoLength ts_L2Pseudolength(uint6_t len) := {
Harald Welte9419c8a2017-07-30 04:07:05 +0200150 l2_plen := len,
151 zero_one := '01'B
152 };
153
154 type record RrHeader {
155 L2PseudoLength l2_plen,
156 uint4_t skip_indicator,
157 uint4_t rr_protocol_discriminator,
158 RrMessageType message_type
159 } with { variant "" };
160
161 template RrHeader t_RrHeader(RrMessageType msg_type, template uint6_t len) := {
Harald Weltef8df4cb2018-03-10 15:15:08 +0100162 l2_plen := tr_L2Pseudolength(len),
Harald Welte9419c8a2017-07-30 04:07:05 +0200163 skip_indicator := 0,
164 rr_protocol_discriminator := 6,
165 message_type := msg_type
166 };
167
Harald Weltef8df4cb2018-03-10 15:15:08 +0100168 template (value) RrHeader ts_RrHeader(RrMessageType msg_type, uint6_t len) := {
169 l2_plen := ts_L2Pseudolength(len),
170 skip_indicator := 0,
171 rr_protocol_discriminator := 6,
172 message_type := msg_type
173 };
174
175
Harald Welte9419c8a2017-07-30 04:07:05 +0200176 type record RrL3Header {
177 uint4_t skip_indicator,
178 uint4_t rr_protocol_discriminator,
179 RrMessageType message_type
180 } with { variant "" };
181
Harald Weltecbc947f2018-02-22 00:26:55 +0100182 template RrL3Header t_RrL3Header(RrMessageType msg_type) := {
183 skip_indicator := 0,
184 rr_protocol_discriminator := 6,
185 message_type := msg_type
186 }
187
Pau Espin Pedrol0aad5962018-09-28 16:03:55 +0200188 /* TS 44.004 7.2.1 */
189 type record SacchL1Header {
190 uint2_t reserved,
191 boolean fpc,
192 uint5_t ms_power_lvl,
193 uint8_t actual_ta
194 } with { variant "FIELDORDER(msb)" };
195
Vadim Yanitskiy79da4ce2020-10-17 15:48:47 +0700196 external function enc_SacchL1Header(in SacchL1Header hdr) return octetstring
197 with { extension "prototype(convert) encode(RAW)" };
198 external function dec_SacchL1Header(in octetstring stream) return SacchL1Header
199 with { extension "prototype(convert) decode(RAW)" };
200
Pau Espin Pedrol0aad5962018-09-28 16:03:55 +0200201 template (value) SacchL1Header ts_SacchL1Header(uint5_t ms_power_lvl, boolean fpc, uint8_t actual_ta) := {
202 reserved := 0,
203 fpc := fpc,
204 ms_power_lvl := ms_power_lvl,
205 actual_ta := actual_ta
206 };
207
Harald Welte9419c8a2017-07-30 04:07:05 +0200208 type record MaioHsn {
Vadim Yanitskiyff0072c2020-05-27 01:35:39 +0700209 uint6_t maio,
210 uint6_t hsn
Harald Welte9419c8a2017-07-30 04:07:05 +0200211 } with { variant "" };
212
Vadim Yanitskiy5bcd9192020-07-06 20:18:11 +0700213 /* It's more handy to pass HSN first, so the arguments' order is reversed. */
214 template (value) MaioHsn ts_HsnMaio(template (value) uint6_t hsn,
215 template (value) uint6_t maio) := {
216 maio := maio,
217 hsn := hsn
218 };
219 template MaioHsn tr_HsnMaio(template (present) uint6_t hsn,
220 template (present) uint6_t maio) := {
221 maio := maio,
222 hsn := hsn
223 };
224
Harald Welte9419c8a2017-07-30 04:07:05 +0200225 /* TS 24.008 10.5.1.2 */
226 type uint4_t CipheringKeySeqNr (0..7);
227
Harald Welte9419c8a2017-07-30 04:07:05 +0200228 /* TS 24.008 10.5.1.4 */
229 type enumerated MobileIdentityType {
230 MI_TYPE_NONE (0),
231 MI_TYPE_IMSI,
232 MI_TYPE_IMEI,
233 MI_TYPE_IMEISV,
234 MI_TYPE_TMSI,
235 MI_TYPE_TMGI
236 } with { variant "FIELDLENGTH(3)" };
237
Harald Welte9419c8a2017-07-30 04:07:05 +0200238 /* TS 24.008 10.5.1.5 */
239 type record MsClassmark1 {
240 BIT1 spare,
241 uint2_t rev_level,
242 boolean es_ind,
243 boolean a51,
244 uint3_t rf_pwr_cap
245 } with { variant "" };
246
247 /* TS 24.008 10.5.1.6 */
248 type record MsClassmark2 {
249 BIT1 spare,
250 uint2_t rev_level,
251 boolean es_ind,
252 boolean a51,
253 uint3_t rf_pwr_cap,
254 BIT1 spare1,
255 boolean ps_cap,
256 uint2_t ss_screen_ind,
257 boolean sm_cap,
258 boolean vbs,
259 boolean vgcs,
260 boolean fc,
261 boolean cm3,
262 BIT1 spare2,
263 boolean lcsva_cap,
264 boolean ucs2,
265 boolean solsa,
266 boolean cmsp,
267 boolean a53,
268 boolean a52
269 } with { variant "" };
270 type record MsClassmark2LV {
271 uint8_t len,
272 MsClassmark2 cm2
273 } with { variant (len) "LENGTHTO(cm2)" };
274
275
276 /* 44.018 10.5.2.5 */
277 type record ChannelDescription {
278 RslChannelNr chan_nr,
279 uint3_t tsc,
280 boolean h,
281 uint12_t arfcn optional,
282 MaioHsn maio_hsn optional
283 } with { variant (arfcn) "PRESENCE(h = false)"
284 variant (maio_hsn) "PRESENCE(h = true)" };
285
286 type record ChannelDescriptionTV {
287 OCT1 iei,
288 ChannelDescription v
289 } with { variant "" };
290
291 /* 10.5.2.21 */
Vadim Yanitskiy3b464a92020-08-25 03:55:32 +0700292 type record MobileAllocationLV {
Harald Welte9419c8a2017-07-30 04:07:05 +0200293 uint8_t len,
Vadim Yanitskiy7d6eef32020-08-29 02:56:58 +0700294 bitstring ma length (0..64)
Vadim Yanitskiy3ddb3ab2020-07-20 04:29:53 +0700295 } with {
296 variant (len) "LENGTHTO(ma)"
Vadim Yanitskiye2a6fdf2020-07-23 04:53:02 +0700297 variant (ma) "BYTEORDER(first), BITORDER(msb)"
Vadim Yanitskiy3ddb3ab2020-07-20 04:29:53 +0700298 };
Harald Welte9419c8a2017-07-30 04:07:05 +0200299
Vadim Yanitskiy74e1f6b2020-08-25 03:59:45 +0700300 type record MobileAllocationTLV {
301 OCT1 iei ('72'O),
302 MobileAllocationLV v
303 } with { variant "" };
304
Harald Welte9419c8a2017-07-30 04:07:05 +0200305 /* 10.5.2.25a */
Harald Welte1b9b7702017-07-30 04:19:14 +0200306 type record PktChDesc0Ind {
307 uint6_t maio,
308 BIT1 ma_number_ind,
309 BIT1 change_mark1_valid,
310 BIT2 change_mark1
311 } with { variant "" };
312 type record PktChDesc0 {
313 BIT1 hopping,
314 BIT1 spare ('0'B),
315 uint10_t arfcn optional,
316 PktChDesc0Ind indirect optional
317 } with {
318 variant (arfcn) "PRESENCE(hopping = '0'B)"
319 variant (indirect) "PRESENCE(hopping = '1'B)"
320 };
321 type record PktChDesc1 {
322 uint6_t maio,
323 uint6_t hsn
324 } with { variant "" };
325 type record PacketChannelDescription {
326 uint5_t channel_Type_spare,
327 uint3_t tn,
328 uint3_t tsc,
329 BIT1 presence,
330 PktChDesc0 zero optional,
331 PktChDesc1 one optional
332 } with {
333 variant (zero) "PRESENCE(presence = '0'B)"
334 variant (one) "PRESENCE(presence = '1'B)"
335 };
Harald Welte9419c8a2017-07-30 04:07:05 +0200336
337 /* 10.5.2.25b */
338 type record DedicatedModeOrTbf {
339 BIT1 spare,
340 boolean tma,
341 boolean downlink,
342 boolean tbf
343 } with { variant "" };
344
345 /* 10.5.2.26 */
346 type enumerated PageMode {
347 PAGE_MODE_NORMAL,
348 PAGE_MODE_EXTENDED,
349 PAGE_MODE_REORGANIZATION,
350 PAGE_MODE_SAME_AS_BEFORE
351 } with { variant "FIELDLENGTH(4)" };
352
353 /* 10.5.2.30 */
354 type record RequestReference {
355 bitstring ra length(8),
356 uint5_t t1p,
357 uint6_t t3,
358 uint5_t t2
359 } with { variant "" };
360
361 template RequestReference t_RequestReference(template bitstring ra, template uint5_t t1p, template uint6_t t3, template uint5_t t2) := {
362 ra := ra,
363 t1p := t1p,
364 t3 := t3,
365 t2 := t2
366 }
367
368 /* compute the expected request reference for given RA + FN */
369 function f_compute_ReqRef(uint8_t ra, GsmFrameNumber fn) return RequestReference {
370 var RequestReference req_ref := { ra := int2bit(ra, 8) };
371 req_ref.t1p := (fn / 1326) mod 32;
372 req_ref.t2 := fn mod 26;
373 req_ref.t3 := fn mod 51;
374 return req_ref
375 }
Harald Weltee8d750e2018-06-10 21:41:35 +0200376 function tr_compute_ReqRef(template uint8_t ra, template GsmFrameNumber fn)
377 return template RequestReference {
378 var template RequestReference req_ref;
379 if (istemplatekind(ra, "?")) {
380 req_ref.ra := ?;
381 } else {
382 req_ref.ra := int2bit(valueof(ra), 8);
383 }
384 if (istemplatekind(fn, "?")) {
385 req_ref.t1p := ?;
386 req_ref.t2 := ?;
387 req_ref.t3 := ?;
388 } else {
389 var GsmFrameNumber fn_v := valueof(fn);
390 req_ref.t1p := (fn_v / 1326) mod 32;
391 req_ref.t2 := fn_v mod 26;
392 req_ref.t3 := fn_v mod 51;
393 }
394 return req_ref;
395 }
Harald Welte9419c8a2017-07-30 04:07:05 +0200396
397 /* 10.5.2.40 */
398 type integer TimingAdvance (0..219);
399
400 /* 10.5.2.43 */
401 type uint8_t WaitIndication;
402
403 /* 10.5.2.76 */
404 type record FeatureIndicator {
Vadim Yanitskiyc3cebd32020-05-22 02:43:22 +0700405 BIT2 peo_bcch_change_mark,
406 boolean cs_ir,
407 boolean ps_ir
408 } with {
409 variant (cs_ir) "FIELDLENGTH(1)"
410 variant (ps_ir) "FIELDLENGTH(1)"
411 };
Harald Welte9419c8a2017-07-30 04:07:05 +0200412
413 /* 24.008 10.5.5.6 */
414 type record DrxParameter {
415 uint8_t split_pg_cycle_code,
416 uint4_t drx_cycle_len_coeff,
417 boolean split_on_ccch,
418 uint3_t non_drx_timer
419 } with { variant "" };
420
Harald Welte9419c8a2017-07-30 04:07:05 +0200421 /* 44.018 10.5.2.16 */
422 type record IaRestOctHL {
423 uint6_t freq_par_len,
424 BIT2 padding ('00'B) optional,
425 uint6_t maio optional,
426 octetstring mobile_allocation optional
427 } with {
428 variant (freq_par_len) "LENGTHTO(mobile_allocation,maio,padding)"
429/*
430 variant (padding) "PRESENCE(freq_par_len != 0)"
431 variant (maio) "PRESENCE(freq_par_len != 0)"
432 variant (mobile_allocation) "PRESENCE(freq_par_len != 0)"
433*/
434 };
Vadim Yanitskiy7091e8d2019-09-09 01:07:37 +0200435 type record SecondPartAssign {
Vadim Yanitskiyb021ed42020-04-27 23:25:13 +0700436 BIT1 r99, /* L / H */
Vadim Yanitskiy7091e8d2019-09-09 01:07:37 +0200437 BIT1 presence optional,
438 BIT5 ext_ra optional
Harald Welte9419c8a2017-07-30 04:07:05 +0200439 } with {
Vadim Yanitskiyb021ed42020-04-27 23:25:13 +0700440 variant (r99) "CSN.1 L/H"
Vadim Yanitskiy7091e8d2019-09-09 01:07:37 +0200441 variant (presence) "PRESENCE(r99 = '1'B)" /* H */
442 variant (ext_ra) "PRESENCE(presence = '1'B)"
Vadim Yanitskiye05d7162020-05-02 16:58:46 +0700443 /* See https://bugs.eclipse.org/bugs/show_bug.cgi?id=562488 */
444 variant (ext_ra) "BYTEORDER(last)" // FIXME: should be first
Vadim Yanitskiy7091e8d2019-09-09 01:07:37 +0200445 };
446 type union PacketUlDlAssignUnion {
447 PacketUlAssign ul,
448 PacketDlAssign dl
449 };
450 type record PacketUlDlAssign {
451 BIT1 ass_disc,
452 PacketUlDlAssignUnion ass
453 } with {
454 variant (ass) "CROSSTAG(dl, ass_disc = '1'B; ul, ass_disc = '0'B)"
455 };
456 type union PacketAssignUnion {
457 SecondPartAssign spa,
458 PacketUlDlAssign uldl
459 };
460 type record IaRestOctHH {
461 /* Packet Assignment discriminator:
462 * Packet Uplink / Downlink Assignment (0)
463 * Second Part Packet Assignment (1) */
464 BIT1 pa_disc,
465 PacketAssignUnion pa
466 } with {
467 variant (pa) "CROSSTAG(spa, pa_disc = '1'B; uldl, pa_disc = '0'B)"
Harald Welte9419c8a2017-07-30 04:07:05 +0200468 };
469 type record PacketUlAssignDyn {
470 uint5_t tfi_assignment,
471 BIT1 polling,
472 BIT1 spare ('0'B),
473 uint3_t usf,
474 BIT1 usf_granularity,
475 BIT1 p0_present,
476 uint4_t p0 optional,
477 BIT1 pr_mode optional,
478 ChCodingCommand ch_coding_cmd,
479 BIT1 tlli_block_chan_coding,
480 BIT1 alpha_present,
481 uint4_t alpha optional,
482 uint5_t gamma,
483 BIT1 ta_index_present,
484 uint4_t ta_index optional,
485 BIT1 tbf_starting_time_present,
486 uint16_t tbf_starting_time optional
487 } with {
488 variant (p0) "PRESENCE(p0_present = '1'B)"
489 variant (pr_mode) "PRESENCE(p0_present = '1'B)"
490 variant (alpha) "PRESENCE(alpha_present = '1'B)"
491 variant (ta_index) "PRESENCE(ta_index_present = '1'B)"
492 variant (tbf_starting_time) "PRESENCE(tbf_starting_time_present = '1'B)"
493 };
494 type record PacketUlAssignSgl {
495 BIT1 alpha_present,
496 uint4_t alpha optional,
497 uint5_t gamma,
498 BIT2 padding ('01'B),
499 uint16_t tbf_starting_time
500 /* TODO: P0 / PR_MODE */
501 } with {
502 variant (alpha) "PRESENCE(alpha_present = '1'B)"
503 };
504 type record PacketUlAssign {
505 BIT1 presence,
506 PacketUlAssignDyn dynamic optional,
507 PacketUlAssignSgl single optional
508 /* TODO: Estended RA, PFI */
509 } with {
510 variant (dynamic) "PRESENCE(presence = '1'B)"
511 variant (single) "PRESENCE(presence = '0'B)"
512 };
513 type record PacketDlAssG1 {
514 uint5_t tfi_assignment,
515 BIT1 rlc_mode,
516 BIT1 alpha_present,
517 uint4_t alpha optional,
518 uint5_t gamma,
519 BIT1 polling,
520 BIT1 ta_valid
521 } with { variant "" };
522 type record PacketDlAssign {
523 GprsTlli tlli,
524 BIT1 group1_present,
525 PacketDlAssG1 group1 optional,
526 BIT1 ta_index_present,
527 uint4_t ta_index optional,
528 BIT1 tbf_starting_time_present,
529 uint16_t tbf_starting_time optional,
530 BIT1 p0_present,
531 uint4_t p0 optional,
532 BIT1 pr_mode optional
533 /* TODO: EGPRS window size, etc. */
534 } with {
535 variant (group1) "PRESENCE(group1_present = '1'B)"
536 variant (ta_index) "PRESENCE(ta_index_present = '1'B)"
537 variant (tbf_starting_time) "PRESENCE(tbf_starting_time_present = '1'B)"
538 variant (p0) "PRESENCE(p0_present = '1'B)"
539 variant (pr_mode) "PRESENCE(p0_present = '1'B)"
540 };
541 type record IaRestOctLL {
542 BIT1 compressed_irat_ho_info_ind
Vadim Yanitskiyb021ed42020-04-27 23:25:13 +0700543 } with {
544 variant (compressed_irat_ho_info_ind) "CSN.1 L/H"
545 };
Pau Espin Pedrol461ed612019-12-30 20:18:34 +0100546 type record EgprsUlAssignDyn {
547 uint5_t tfi_assignment,
548 BIT1 polling,
549 BIT1 spare ('0'B),
550 uint3_t usf,
551 BIT1 usf_granularity,
552 BIT1 p0_present,
553 uint4_t p0 optional,
554 BIT1 pr_mode optional,
555 EgprsChCodingCommand egprs_ch_coding_cmd,
556 BIT1 tlli_block_chan_coding,
557 BIT1 bep_period2_present,
558 BIT4 bep_period2 optional,
559 BIT1 resegment,
560 EgprsWindowSize egprs_window_size,
561 BIT1 alpha_present,
562 uint4_t alpha optional,
563 uint5_t gamma,
564 BIT1 ta_index_present,
565 uint4_t ta_index optional,
566 BIT1 tbf_starting_time_present,
567 uint16_t tbf_starting_time optional
568 /* TODO: Additions for Rel-7 */
569 } with {
570 variant (p0) "PRESENCE(p0_present = '1'B)"
571 variant (pr_mode) "PRESENCE(p0_present = '1'B)"
572 variant (bep_period2) "PRESENCE(bep_period2_present = '1'B)"
573 variant (alpha) "PRESENCE(alpha_present = '1'B)"
574 variant (ta_index) "PRESENCE(ta_index_present = '1'B)"
575 variant (tbf_starting_time) "PRESENCE(tbf_starting_time_present = '1'B)"
576 };
577 type record EgprsUlAssignMultiblock {
578 BIT1 alpha_present,
579 uint4_t alpha optional,
580 uint5_t gamma,
581 uint16_t tbf_starting_time,
582 BIT2 nr_radio_blocks_allocated,
583 BIT1 p0_present,
584 uint4_t p0 optional,
585 BIT1 spare ('0'B) optional,
586 BIT1 pr_mode optional
587 /* TDO: Additions for Rel-6 */
588 } with {
589 variant (alpha) "PRESENCE(alpha_present = '1'B)"
590 variant (p0) "PRESENCE(p0_present = '1'B)"
591 variant (spare) "PRESENCE(p0_present = '1'B)"
592 variant (pr_mode) "PRESENCE(p0_present = '1'B)"
593 };
594 /* 3GPP TS 44.018 version 13.3.2 10.5.2.16, "EGPRS Packet Uplink Assignment" */
595 type record EgprsUlAss {
596 BIT5 ext_ra,
597 BIT1 ats_present,
598 AccessTechnologiesRequestRepetition ats optional,
599 BIT1 presence,
600 EgprsUlAssignDyn dynamic optional,
601 EgprsUlAssignMultiblock multiblock optional
602 } with {
603 variant (ats) "PRESENCE(ats_present = '1'B)"
604 variant (dynamic) "PRESENCE(presence = '1'B)"
605 variant (multiblock) "PRESENCE(presence = '0'B)"
Vadim Yanitskiye05d7162020-05-02 16:58:46 +0700606 /* See https://bugs.eclipse.org/bugs/show_bug.cgi?id=562488 */
607 variant (ext_ra) "BYTEORDER(last)" // FIXME: should be first
Pau Espin Pedrol461ed612019-12-30 20:18:34 +0100608 };
609
Harald Welte9419c8a2017-07-30 04:07:05 +0200610 type octetstring MblkDlAss; /* TODO */
611 type record IaRestOctLH {
612 BIT2 presence,
613 EgprsUlAss egprs_ul optional,
614 MblkDlAss multiblock_dl_ass optional
615 } with {
616 variant (egprs_ul) "PRESENCE(presence = '00'B)"
617 variant (multiblock_dl_ass) "PRESENCE(presence = '01'B)"
618 };
619 type record IaRestOctets {
620 BIT2 presence,
621 IaRestOctLL ll optional,
622 IaRestOctLH lh optional,
623 IaRestOctHL hl optional,
Vadim Yanitskiy9b2a3e82019-09-08 15:37:15 +0200624 IaRestOctHH hh optional
Harald Welte9419c8a2017-07-30 04:07:05 +0200625 } with {
Vadim Yanitskiyb021ed42020-04-27 23:25:13 +0700626 variant (presence) "CSN.1 L/H"
Harald Welte9419c8a2017-07-30 04:07:05 +0200627 variant (ll) "PRESENCE(presence = '00'B)"
628 variant (lh) "PRESENCE(presence = '01'B)"
629 variant (hl) "PRESENCE(presence = '10'B)"
630 variant (hh) "PRESENCE(presence = '11'B)"
Vadim Yanitskiy9b2a3e82019-09-08 15:37:15 +0200631 variant "PADDING(yes), PADDING_PATTERN('00101011'B)"
Harald Welte9419c8a2017-07-30 04:07:05 +0200632 };
633
Harald Weltecbc947f2018-02-22 00:26:55 +0100634 type record MeasurementResults {
635 BIT1 ba_used,
636 BIT1 dtx_used,
637 uint6_t rxlev_full_srv_cell,
638 BIT1 threeg_ba_used,
639 BIT1 meas_valid,
640 uint6_t rxlev_sub_srv_cell,
641 BIT1 si23_ba_used,
642 uint3_t rxqual_full_srv_cell,
643 uint3_t rxqual_sub_srv_cell,
644 uint3_t no_ncell_m,
645 NcellReports ncell_reports optional
646 } with { variant (no_ncell_m) "LENGTHTO(ncell_reports)"
647 variant (no_ncell_m) "UNIT(elements)"
648 variant "PADDING(yes)"
649 variant "FIELDLENGTH(16)"
650 };
651
652 type record NcellReport {
653 uint6_t rxlev,
654 uint5_t bcch_freq,
655 uint6_t bsic
656 } with { variant ""};
657 type record of NcellReport NcellReports;
658
Harald Welte9419c8a2017-07-30 04:07:05 +0200659
Vadim Yanitskiy27b38012020-09-01 05:14:46 +0700660 /* 3GPP TS 44.018, section 9.1.2 (minimalistic implementation) */
661 type record AssignmentCommand {
662 ChannelDescription chan_desc,
663 PowerCommand_V power_cmd,
664 FrequencyList_TLV freq_list_at optional,
665 CellChannelDescription_TV cell_chan_desc optional,
666 /* TODO: Multislot Allocation IE */
667 ChannelMode_TV chan1_mode optional,
668 ChannelMode_TV chan2_mode optional,
669 /* TODO: Mode of Channel Set 3..8 IE */
670 MobileAllocationTLV mobile_allocation optional
671 /* TODO: more optional IEs... */
672 } with {
673 variant "TAG(
674 freq_list_at, elementIdentifier = '05'O;
675 cell_chan_desc, elementIdentifier = '62'O;
676 chan1_mode, elementIdentifier = '63'O;
677 chan2_mode, elementIdentifier = '11'O;
678 mobile_allocation, iei = '72'O;
679 )"
680 };
681
Vadim Yanitskiy5fec37c2020-09-02 17:19:47 +0700682 /* 3GPP TS 44.018, section 9.1.15 (minimalistic implementation) */
683 type record HandoverCommand {
684 CellDescriptionV cell_desc,
685 ChannelDescription chan_desc,
686 OCT1 ho_ref,
687 PowerCommandAndAccesstype_V power_cmd_acc_type,
688 FrequencyList_TLV freq_list_at optional,
689 CellChannelDescription_TV cell_chan_desc optional,
690 ChannelMode_TV chan1_mode optional,
691 ChannelMode_TV chan2_mode optional,
692 /* TODO: Mode of Channel Set 3..8 IE */
693 MobileAllocationTLV mobile_allocation optional
694 /* TODO: more optional IEs... */
695 } with {
696 variant "TAG(
697 freq_list_at, elementIdentifier = '05'O;
698 cell_chan_desc, elementIdentifier = '62'O;
699 chan1_mode, elementIdentifier = '63'O;
700 chan2_mode, elementIdentifier = '11'O;
701 mobile_allocation, iei = '72'O;
702 )"
703 };
704
705 /* 10.5.2.2 Cell Description IE */
706 type record CellDescriptionV {
707 uint3_t bcc, /* PLMN colour code */
708 uint3_t ncc, /* BS colour code */
709 uint10_t bcch_arfcn
710 } with { variant "FIELDORDER(lsb)" };
711
Vadim Yanitskiy27b38012020-09-01 05:14:46 +0700712
Harald Welte9419c8a2017-07-30 04:07:05 +0200713 /* 9.1.18 */
714 type record ImmediateAssignment {
715 DedicatedModeOrTbf ded_or_tbf,
716 PageMode page_mode,
717 ChannelDescription chan_desc optional,
718 PacketChannelDescription pkt_chan_desc optional,
719 RequestReference req_ref,
720 TimingAdvance timing_advance,
Vadim Yanitskiy3b464a92020-08-25 03:55:32 +0700721 MobileAllocationLV mobile_allocation,
Harald Welte9419c8a2017-07-30 04:07:05 +0200722 /* TODO: starting time TLV */
Vadim Yanitskiyf10bb452019-09-05 13:53:01 +0200723 IaRestOctets rest_octets
Harald Welte9419c8a2017-07-30 04:07:05 +0200724 } with { variant (chan_desc) "PRESENCE(ded_or_tbf.tbf = false)"
Vadim Yanitskiya4aacc22019-09-09 04:41:12 +0200725 variant (pkt_chan_desc) "PRESENCE(ded_or_tbf.tbf = true)" };
Harald Welte9419c8a2017-07-30 04:07:05 +0200726
727 /* 9.1.20 */
728 type record ReqRefWaitInd {
729 RequestReference req_ref,
730 WaitIndication wait_ind
731 } with { variant "" };
732 type record length(4) of ReqRefWaitInd ReqRefWaitInd4;
733 type record ImmediateAssignmentReject {
734 FeatureIndicator feature_ind,
735 PageMode page_mode,
Vadim Yanitskiy7ef121d2020-05-22 03:04:22 +0700736 ReqRefWaitInd4 payload,
737 IARRestOctets rest_octets
Harald Welte9419c8a2017-07-30 04:07:05 +0200738 } with { variant "" };
739
Vadim Yanitskiy7ef121d2020-05-22 03:04:22 +0700740 /* 10.5.2.17 IAR (Immediate Assignment Reject) Rest Octets */
741 type record IARRestOctets {
742 ExtRAList ext_ra_list,
743 BIT1 rel13_ind, // L/H
744 uint3_t rcc optional
745 /* Addition in Rel-15: PEO IMM Cell Group Details struct */
746 } with {
747 variant (rel13_ind) "CSN.1 L/H"
748 variant (rcc) "PRESENCE(rel13_ind = '1'B)"
749
750 /* The TITAN's RAW encoder generates an octet-aligned octetstring,
751 * so we should make sure that unused bits contain proper padding. */
752 variant "PADDING(yes), PADDING_PATTERN('00101011'B)"
753 };
754
755 /* Optional extended RA: 0 | 1 < Extended RA 1 : bit (5) > */
756 type record ExtRAOpt {
757 BIT1 presence, // L/H
758 BIT5 ext_ra optional
759 } with {
760 variant (presence) "CSN.1 L/H"
761 variant (ext_ra) "PRESENCE(presence = '1'B)"
762 /* See https://bugs.eclipse.org/bugs/show_bug.cgi?id=562488 */
763 variant (ext_ra) "BYTEORDER(last)"
764 };
765
766 type record length(4) of ExtRAOpt ExtRAList;
767
Harald Weltecbc947f2018-02-22 00:26:55 +0100768 /* 9.1.21 */
769 type record MeasurementReport {
770 MeasurementResults meas_res
771 } with { variant "" };
772
Harald Welte9419c8a2017-07-30 04:07:05 +0200773 /* 9.1.22 */
774 type record PagingRequestType1 {
775 ChannelNeeded12 chan_needed,
776 PageMode page_mode,
777 MobileIdentityLV mi1,
778 MobileIdentityTLV mi2 optional,
779 RestOctets rest_octets
Vadim Yanitskiy98bb2d52020-03-28 00:57:21 +0700780 } with { variant "TAG(mi2, elementIdentifier = '0010111'B)" };
Harald Welte9419c8a2017-07-30 04:07:05 +0200781
782 /* 9.1.23 */
783 type record PagingRequestType2 {
784 ChannelNeeded12 chan_needed,
785 PageMode page_mode,
786 GsmTmsi mi1,
787 GsmTmsi mi2,
788 MobileIdentityTLV mi3 optional,
789 RestOctets rest_octets
Vadim Yanitskiy98bb2d52020-03-28 00:57:21 +0700790 } with { variant "TAG(mi3, elementIdentifier = '0010111'B)" };
Harald Welte9419c8a2017-07-30 04:07:05 +0200791
792 /* 9.1.24 */
793 type record length(4) of GsmTmsi GsmTmsi4;
794 type record PagingRequestType3 {
795 ChannelNeeded12 chan_needed,
796 PageMode page_mode,
797 GsmTmsi4 mi,
798 RestOctets rest_octets
799 } with { variant "" };
800
Harald Welte9419c8a2017-07-30 04:07:05 +0200801 type union RrUnion {
802/*
803 SystemInformationType1 si1,
804 SystemInformationType2 si2,
805 SystemInformationType2bis si2bis,
806 SystemInformationType2ter si2ter,
Harald Welte82ccef72018-02-25 16:17:33 +0100807 SystemInformationType3 si3,
Harald Welte9419c8a2017-07-30 04:07:05 +0200808 SystemInformationType4 si4,
809 SystemInformationType5 si5,
810 SystemInformationType5bis si5bis,
811 SystemInformationType5ter si5ter,
812 SystemInformationType6 si6,
813*/
814 ImmediateAssignment imm_ass,
815 ImmediateAssignmentReject imm_ass_rej,
816 PagingRequestType1 pag_req_1,
817 PagingRequestType2 pag_req_2,
818 PagingRequestType3 pag_req_3,
819 octetstring other
820 } with { variant "" };
821
822 /* Special RR Message on BCCH / CCCH Dowlink */
823
824 type record GsmRrMessage {
825 RrHeader header,
826 RrUnion payload
827 } with { variant (payload) "CROSSTAG(
828/*
829 si1, header.message_type = SYSTEM_INFORMATION_TYPE_1;
830 si2, header.message_type = SYSTEM_INFORMATION_TYPE_2;
831 si2bis, header.message_type = SYSTEM_INFORMATION_TYPE_2bis;
832 si2ter, header.message_type = SYSTEM_INFORMATION_TYPE_2ter;
833 si3, header.message_type = SYSTEM_INFORMATION_TYPE_3;
834 si4, header.message_type = SYSTEM_INFORMATION_TYPE_4;
835 si5, header.message_type = SYSTEM_INFORMATION_TYPE_5;
836 si5bis, header.message_type = SYSTEM_INFORMATION_TYPE_5bis;
837 si5ter, header.message_type = SYSTEM_INFORMATION_TYPE_5ter;
838 si6, header.message_type = SYSTEM_INFORMATION_TYPE_6;
839*/
840 imm_ass, header.message_type = IMMEDIATE_ASSIGNMENT;
841 imm_ass_rej, header.message_type = IMMEDIATE_ASSIGNMENT_REJECT;
842 pag_req_1, header.message_type = PAGING_REQUEST_TYPE_1;
843 pag_req_2, header.message_type = PAGING_REQUEST_TYPE_2;
844 pag_req_3, header.message_type = PAGING_REQUEST_TYPE_3;
845 other, OTHERWISE;
Vadim Yanitskiya4aacc22019-09-09 04:41:12 +0200846 )"
847 /* Total message length: 184 = 23 * 8. Pad spare bits with '2B'O. */
848 variant "PADDING(184), PADDING_PATTERN('00101011'B)"
849 };
Harald Welte9419c8a2017-07-30 04:07:05 +0200850
851 external function enc_GsmRrMessage(in GsmRrMessage msg) return octetstring
852 with { extension "prototype(convert) encode(RAW)" };
853 external function dec_GsmRrMessage(in octetstring stream) return GsmRrMessage
854 with { extension "prototype(convert) decode(RAW)" };
855
856 /* Normal L3 Message on Dedicated Channel */
857
858 /* 9.1.25 Paging Response */
859 type record PagingResponse {
860 uint4_t spare_half_octet,
861 CipheringKeySeqNr cksn,
862 MsClassmark2LV cm2,
863 MobileIdentityLV mi,
864 uint8_t addl_upd_par optional
865 } with { variant "" };
866
867 type union RrL3Union {
Vadim Yanitskiy480c2ac2020-09-01 05:43:06 +0700868 PagingResponse paging_response,
869 MeasurementReport meas_rep,
870 AssignmentCommand ass_cmd,
Vadim Yanitskiy5fec37c2020-09-02 17:19:47 +0700871 HandoverCommand ho_cmd,
Vadim Yanitskiy480c2ac2020-09-01 05:43:06 +0700872 octetstring other
Harald Welte9419c8a2017-07-30 04:07:05 +0200873 };
874
875 type record GsmRrL3Message {
876 RrL3Header header,
877 RrL3Union payload
878 } with { variant (payload) "CROSSTAG(
879 paging_response, header.message_type = PAGING_RESPONSE;
Harald Weltecbc947f2018-02-22 00:26:55 +0100880 meas_rep, header.message_type = MEASUREMENT_REPORT;
Vadim Yanitskiy27b38012020-09-01 05:14:46 +0700881 ass_cmd, header.message_type = ASSIGNMENT_COMMAND;
Vadim Yanitskiy5fec37c2020-09-02 17:19:47 +0700882 ho_cmd, header.message_type = HANDOVER_COMMAND;
Harald Welte9419c8a2017-07-30 04:07:05 +0200883 other, OTHERWISE;
884 )" }
885
Harald Weltecbc947f2018-02-22 00:26:55 +0100886 external function enc_GsmRrL3Message(in GsmRrL3Message msg) return octetstring
887 with { extension "prototype(convert) encode(RAW)" };
888 external function dec_GsmRrL3Message(in octetstring stream) return GsmRrL3Message
889 with { extension "prototype(convert) decode(RAW)" };
890
891
Vadim Yanitskiy7091e8d2019-09-09 01:07:37 +0200892 template PacketDlAssign tr_PacketDlAssign(template GprsTlli tlli) := {
893 tlli := tlli,
894 group1_present := ?,
895 group1 := *,
896 ta_index_present := ?,
897 ta_index := *,
898 tbf_starting_time_present := ?,
899 tbf_starting_time := *,
900 p0_present := ?,
901 p0 := *,
902 pr_mode := *
903 };
904
905 template IaRestOctets tr_IaRestOctets_DLAss(template PacketDlAssign dl_ass) := {
906 presence := '11'B, /* HH */
907 ll := omit, lh := omit, hl := omit,
908 hh := {
909 pa_disc := '0'B, /* Packet Assignment (0) */
910 pa := {
911 uldl := {
912 ass_disc := '1'B, /* Downlink Assignment (1) */
913 ass := { dl := dl_ass }
914 }
915 }
916 }
917 };
918
919 template PacketUlAssign tr_PacketUlDynAssign(template uint5_t tfi := ?,
920 template BIT1 polling := ?,
921 template uint3_t usf := ?,
922 template BIT1 usf_granularity := ?,
923 template ChCodingCommand cs := ?) := {
Vadim Yanitskiy06ca64d2019-09-29 20:17:10 +0700924 presence := '1'B, /* Dynamic Block Allocation */
Vadim Yanitskiy7091e8d2019-09-09 01:07:37 +0200925 dynamic := {
926 tfi_assignment := tfi,
927 polling := polling,
Vadim Yanitskiy06ca64d2019-09-29 20:17:10 +0700928 spare := '0'B, /* Dynamic Block Allocation (mandatory after Rel-4) */
Vadim Yanitskiy7091e8d2019-09-09 01:07:37 +0200929 usf := usf,
930 usf_granularity := usf_granularity,
931 p0_present := ?,
932 p0 := *,
933 pr_mode := *,
934 ch_coding_cmd := cs,
935 tlli_block_chan_coding := ?,
936 alpha_present := ?,
937 alpha := *,
938 gamma := ?,
939 /* TODO: add to parameters */
940 ta_index_present := ?,
941 ta_index := *,
942 tbf_starting_time_present := ?,
943 tbf_starting_time := *
944 },
945 single := omit
946 };
947
948 template PacketUlAssign tr_PacketUlSglAssign := {
Vadim Yanitskiy06ca64d2019-09-29 20:17:10 +0700949 presence := '0'B, /* Single Block Allocation */
Vadim Yanitskiy7091e8d2019-09-09 01:07:37 +0200950 dynamic := omit,
951 single := {
952 alpha_present := ?,
953 alpha := *,
954 gamma := ?,
955 padding := '01'B,
956 tbf_starting_time := ?
957 }
958 };
959
960 template IaRestOctets tr_IaRestOctets_ULAss(template PacketUlAssign ul_ass) := {
961 presence := '11'B, /* HH */
962 ll := omit, lh := omit, hl := omit,
963 hh := {
964 pa_disc := '0'B, /* Packet Assignment (0) */
965 pa := {
966 uldl := {
967 ass_disc := '0'B, /* Uplink Assignment (0) */
968 ass := { ul := ul_ass }
969 }
970 }
971 }
972 };
973
Vadim Yanitskiya0b47cf2020-04-02 01:50:18 +0700974 template EgprsUlAss tr_EgprsUlAssDynamic(template (present) BIT5 ext_ra := ?,
975 template EgprsUlAssignDyn dyn_ass := ?) := {
976 ext_ra := ext_ra,
977 ats_present := ?,
978 ats := *,
979 presence := '1'B,
980 dynamic := dyn_ass,
981 multiblock := omit
982 };
983 template EgprsUlAss tr_EgprsUlAssMultiblock(template (present) BIT5 ext_ra := ?,
984 template EgprsUlAssignMultiblock mb_ass := ?) := {
985 ext_ra := ext_ra,
986 ats_present := ?,
987 ats := *,
988 presence := '0'B,
989 dynamic := omit,
990 multiblock := mb_ass
991 };
992
993 template IaRestOctets tr_IaRestOctets_EGPRSULAss(template EgprsUlAss ul_ass) := {
994 presence := '01'B, /* LH */
995 ll := omit,
996 lh := {
997 presence := '00'B,
998 egprs_ul := ul_ass,
999 multiblock_dl_ass := omit
1000 },
1001 hl := omit,
1002 hh := omit
1003 };
1004
Harald Weltee8d750e2018-06-10 21:41:35 +02001005 template (value) GsmRrMessage ts_IMM_ASS(uint8_t ra, GsmFrameNumber fn, TimingAdvance ta,
Vadim Yanitskiy3b464a92020-08-25 03:55:32 +07001006 ChannelDescription ch_desc, MobileAllocationLV ma) := {
Harald Weltebae6be82020-08-21 12:42:18 +02001007 header := ts_RrHeader(IMMEDIATE_ASSIGNMENT, 0),
Harald Weltecbc947f2018-02-22 00:26:55 +01001008 payload := {
1009 imm_ass := {
1010 ded_or_tbf := {
1011 spare := '0'B,
1012 tma := false,
1013 downlink := false,
1014 tbf := false
1015 },
1016 page_mode := PAGE_MODE_NORMAL,
1017 chan_desc := ch_desc,
1018 pkt_chan_desc := omit,
1019 req_ref := f_compute_ReqRef(ra, fn),
1020 timing_advance := ta,
1021 mobile_allocation := ma,
Vadim Yanitskiyf10bb452019-09-05 13:53:01 +02001022 rest_octets := {
1023 presence := '00'B, /* LL */
1024 ll := {
Vadim Yanitskiyb021ed42020-04-27 23:25:13 +07001025 compressed_irat_ho_info_ind := '0'B /* L */
Vadim Yanitskiy9b2a3e82019-09-08 15:37:15 +02001026 },
1027 lh := omit, hl := omit, hh := omit
Vadim Yanitskiyf10bb452019-09-05 13:53:01 +02001028 }
Harald Weltecbc947f2018-02-22 00:26:55 +01001029 }
1030 }
1031 };
1032
Harald Weltee8d750e2018-06-10 21:41:35 +02001033 template GsmRrMessage tr_IMM_ASS(template uint8_t ra := ?, template GsmFrameNumber fn := ?,
1034 template TimingAdvance ta := ?,
1035 template ChannelDescription ch_desc := ?,
Vadim Yanitskiy3b464a92020-08-25 03:55:32 +07001036 template MobileAllocationLV ma := ?) := {
Vadim Yanitskiyd4205c32019-09-09 16:15:37 +02001037 header := t_RrHeader(IMMEDIATE_ASSIGNMENT, ?),
Harald Weltee8d750e2018-06-10 21:41:35 +02001038 payload := {
1039 imm_ass := {
1040 ded_or_tbf := {
1041 spare := '0'B,
1042 tma := false,
1043 downlink := false,
1044 tbf := false
1045 },
1046 page_mode := PAGE_MODE_NORMAL,
1047 chan_desc := ch_desc,
1048 pkt_chan_desc := omit,
1049 req_ref := tr_compute_ReqRef(ra, fn),
1050 timing_advance := ta,
1051 mobile_allocation := ma,
Vadim Yanitskiyf10bb452019-09-05 13:53:01 +02001052 rest_octets := ?
Harald Weltee8d750e2018-06-10 21:41:35 +02001053 }
1054 }
1055 };
1056
Vadim Yanitskiy6edd4f52019-09-09 01:51:09 +02001057 /* TODO: implement send version of this template */
1058 template GsmRrMessage tr_IMM_TBF_ASS(template boolean dl := ?,
1059 template uint8_t ra := ?,
1060 template GsmFrameNumber fn := ?,
1061 template TimingAdvance ta := ?,
1062 template PacketChannelDescription ch_desc := ?,
Vadim Yanitskiy3b464a92020-08-25 03:55:32 +07001063 template MobileAllocationLV ma := ?,
Vadim Yanitskiy6edd4f52019-09-09 01:51:09 +02001064 template IaRestOctets rest := ?) := {
1065 header := t_RrHeader(IMMEDIATE_ASSIGNMENT, ?),
1066 payload := {
1067 imm_ass := {
1068 ded_or_tbf := {
1069 spare := ?,
1070 tma := ?,
1071 downlink := dl,
1072 tbf := true
1073 },
1074 page_mode := ?,
1075 chan_desc := omit,
1076 pkt_chan_desc := ch_desc,
1077 req_ref := tr_compute_ReqRef(ra, fn),
1078 timing_advance := ta,
Vadim Yanitskiycf1ed3f2020-07-20 04:01:43 +07001079 mobile_allocation := ma,
Vadim Yanitskiy6edd4f52019-09-09 01:51:09 +02001080 rest_octets := rest
1081 }
1082 }
1083 };
Harald Weltee8d750e2018-06-10 21:41:35 +02001084
Vadim Yanitskiy9781ecb2020-03-28 03:59:41 +07001085 template GsmRrMessage tr_PAG_REQ1(template MobileIdentityLV mi1 := ?,
1086 template MobileIdentityTLV mi2 := omit) := {
Pau Espin Pedrol88bf5372019-12-09 21:12:28 +01001087 header := t_RrHeader(PAGING_REQUEST_TYPE_1, ?),
1088 payload := {
1089 pag_req_1 := {
1090 chan_needed := {
1091 second := ?,
1092 first := ?
1093 },
1094 page_mode := PAGE_MODE_NORMAL,
1095 mi1 := mi1,
Vadim Yanitskiy9781ecb2020-03-28 03:59:41 +07001096 mi2 := mi2,
Pau Espin Pedrol88bf5372019-12-09 21:12:28 +01001097 rest_octets := ?
1098 }
1099 }
1100 };
1101
Harald Weltecbc947f2018-02-22 00:26:55 +01001102 template (value) GsmRrL3Message ts_MEAS_REP(boolean valid, uint6_t rxl_f, uint6_t rxl_s,
1103 uint3_t rxq_f, uint3_t rxq_s,
1104 template (omit) NcellReports reps) := {
1105 header := t_RrL3Header(MEASUREMENT_REPORT),
1106 payload := {
1107 meas_rep := {
1108 meas_res := {
1109 ba_used := '0'B,
1110 dtx_used := '0'B,
1111 rxlev_full_srv_cell := rxl_f,
1112 threeg_ba_used := '0'B,
Harald Welteeb1e6812018-02-22 18:43:48 +01001113 meas_valid := bool2bit(not valid),
Harald Weltecbc947f2018-02-22 00:26:55 +01001114 rxlev_sub_srv_cell := rxl_s,
1115 si23_ba_used := '0'B,
1116 rxqual_full_srv_cell := rxq_f,
1117 rxqual_sub_srv_cell := rxq_s,
1118 no_ncell_m := 0,
1119 ncell_reports := reps
1120 }
1121 }
1122 }
1123 };
1124
Vadim Yanitskiy16e24aa2020-05-22 03:32:00 +07001125 template GsmRrMessage tr_IMM_ASS_REJ(template FeatureIndicator feature_ind := ?,
1126 template ReqRefWaitInd4 rr_wi_list := ?,
1127 template IARRestOctets rest_octets := ?) := {
1128 header := t_RrHeader(IMMEDIATE_ASSIGNMENT_REJECT, ?),
1129 payload := {
1130 imm_ass_rej := {
1131 feature_ind := feature_ind,
1132 page_mode := ?,
1133 payload := rr_wi_list,
1134 rest_octets := rest_octets
1135 }
1136 }
1137 };
1138
1139 template ReqRefWaitInd tr_ReqRefWaitInd(template RequestReference ref := ?,
1140 template WaitIndication wi := ?) := {
1141 req_ref := ref,
1142 wait_ind := wi
1143 };
1144
1145 template IARRestOctets tr_IARRestOctets(template ExtRAList ext_ra_list := ?,
1146 template uint3_t rcc := ?) := {
1147 ext_ra_list := ext_ra_list,
1148 rel13_ind := ?,
1149 rcc := rcc ifpresent
1150 };
1151
1152 template ExtRAOpt tr_ExtRAOpt(template BIT5 ext_ra := ?) := {
1153 presence := '1'B, // L/H
1154 ext_ra := ext_ra
1155 };
1156
Vadim Yanitskiyf7181ed2020-07-14 20:12:02 +07001157 template (value) ChannelDescription ts_ChanDescH0(template (value) RslChannelNr chan_nr,
1158 template (value) uint12_t arfcn,
1159 template (value) uint3_t tsc := 7) := {
1160 chan_nr := chan_nr,
1161 tsc := tsc,
1162 h := false,
1163 arfcn := arfcn,
1164 maio_hsn := omit
1165 }
Vadim Yanitskiyc3156ed2020-08-29 17:49:27 +07001166 template ChannelDescription tr_ChanDescH0(template (present) RslChannelNr chan_nr := ?,
1167 template (present) uint12_t arfcn := ?,
1168 template (present) uint3_t tsc := ?) := {
1169 chan_nr := chan_nr,
1170 tsc := tsc,
1171 h := false,
1172 arfcn := arfcn,
1173 maio_hsn := omit
1174 }
Vadim Yanitskiyf7181ed2020-07-14 20:12:02 +07001175
1176 template (value) ChannelDescription ts_ChanDescH1(template (value) RslChannelNr chan_nr,
1177 template (value) MaioHsn maio_hsn,
1178 template (value) uint3_t tsc := 7) := {
1179 chan_nr := chan_nr,
1180 tsc := tsc,
1181 h := true,
1182 arfcn := omit,
1183 maio_hsn := maio_hsn
1184 }
Vadim Yanitskiyc3156ed2020-08-29 17:49:27 +07001185 template ChannelDescription tr_ChanDescH1(template (present) RslChannelNr chan_nr := ?,
1186 template (present) MaioHsn maio_hsn := ?,
1187 template (present) uint3_t tsc := ?) := {
1188 chan_nr := chan_nr,
1189 tsc := tsc,
1190 h := true,
1191 arfcn := omit,
1192 maio_hsn := maio_hsn
1193 }
Vadim Yanitskiyf7181ed2020-07-14 20:12:02 +07001194
Neels Hofmeyr0edf4ac2020-07-10 17:33:24 +02001195
1196 /* Templates for the RR Channel Release message's "Cell selection indicator after release of all TCH and SDCCH" IE.
1197 * See 3GPP TS 44.018 9.1.7 and 10.5.2.1e */
1198
1199 /* 3GPP TS 44.018 10.5.2.1e, Cell Selection Indicator after release of all TCH and SDCCH value part */
1200 type record CellSelIndValue {
1201 BIT3 discr,
1202 CellSelIndValueEnum value_list,
1203 BIT1 value_list_term ('0'B)
1204 } with {
1205 variant (value_list) "CROSSTAG(
1206 gsm, discr='000'B;
1207 utran_fdd, discr='001'B;
1208 utran_tdd, discr='010'B;
1209 eutran, discr='011'B;
1210 )"
1211 };
1212
1213 /* 3GPP TS 44.018 10.5.2.1e, Cell Selection Indicator after release of all TCH and SDCCH value part */
1214 private type union CellSelIndValueEnum {
1215 CellSelIndValue_GSM_Descrs gsm,
1216 CellSelIndValue_UTRAN_Descrs utran_fdd,
1217 CellSelIndValue_UTRAN_Descrs utran_tdd,
1218 CellSelIndValue_EUTRAN_Descrs eutran
1219 } with { variant "" };
1220
1221 type record of CellSelIndValue_GSM_Descr CellSelIndValue_GSM_Descrs;
1222 /* 3GPP TS 44.018 10.5.2.1e, GSM Description struct */
1223 type record CellSelIndValue_GSM_Descr {
1224 BIT1 item_ind ('1'B),
1225 BIT1 band_indicator,
1226 uint10_t arfcn,
1227 uint6_t bsic
1228 } with {
1229 variant "PRESENCE(item_ind = '1'B)"
1230 };
1231
1232 type record of CellSelIndValue_UTRAN_Descr CellSelIndValue_UTRAN_Descrs;
1233 /* 3GPP TS 44.018 10.5.2.1e, UTRAN {FDD,TDD} Description struct */
1234 type record CellSelIndValue_UTRAN_Descr {
1235 BIT1 item_ind ('1'B),
1236 BIT1 bandwidth_presence,
1237 uint3_t bandwidth optional,
1238 uint14_t arfcn,
1239 BIT1 cell_info_presence,
1240 UTRAN_CellInfo cell_info optional
1241 } with {
1242 variant "PRESENCE(item_ind = '1'B)"
1243 variant (bandwidth) "PRESENCE(bandwidth_presence = '1'B)"
1244 variant (cell_info) "PRESENCE(cell_info_presence = '1'B)"
1245 };
1246 type record UTRAN_CellInfo {
1247 BIT1 indic0,
1248 uint5_t nr_of_cells,
1249 // TODO: define cell_information_field
1250 octetstring cell_information_field
1251 } with { variant "" };
1252
1253 type record of CellSelIndValue_EUTRAN_Descr CellSelIndValue_EUTRAN_Descrs;
1254 /* 3GPP TS 44.018 10.5.2.1e, E-UTRAN Description struct */
1255 type record CellSelIndValue_EUTRAN_Descr {
1256 BIT1 item_ind ('1'B),
1257 uint16_t earfcn,
1258 BIT1 meas_bw_presence,
1259 uint3_t meas_bw optional,
1260 BIT1 not_allowed_cells_presence,
1261 // define not_allowed_cells
1262 octetstring not_allowed_cells optional,
1263 BIT1 target_pcid_presence,
1264 uint9_t target_pcid optional
1265 } with {
1266 variant "PRESENCE(item_ind = '1'B)"
1267 variant (meas_bw) "PRESENCE(meas_bw_presence = '1'B)"
1268 variant (not_allowed_cells) "PRESENCE(not_allowed_cells_presence = '1'B)"
1269 variant (target_pcid) "PRESENCE(target_pcid_presence = '1'B)"
1270 };
1271
1272 template CellSelIndValue tr_CellSelIndValue_EUTRAN(
1273 template CellSelIndValue_EUTRAN_Descrs cells := {})
1274 := {
1275 discr := '011'B,
1276 value_list := {
1277 eutran := cells
1278 },
1279 value_list_term := '0'B
1280 };
1281
1282 template CellSelIndValue_EUTRAN_Descr tr_CellSelIndValue_EUTRAN_Descr(
1283 template (present) uint16_t earfcn,
1284 template (present) BIT1 meas_bw_presence := ?,
1285 template uint3_t meas_bw := *)
1286 := {
1287 item_ind := '1'B,
1288 earfcn := earfcn,
1289 meas_bw_presence := meas_bw_presence,
1290 meas_bw := meas_bw,
1291 not_allowed_cells_presence := '0'B,
1292 not_allowed_cells := omit,
1293 target_pcid_presence := '0'B,
1294 target_pcid := omit
1295 };
1296
1297 external function enc_CellSelIndValue(in CellSelIndValue ro) return octetstring
1298 with { extension "prototype(convert) encode(RAW)" };
1299 external function dec_CellSelIndValue(in octetstring stream) return CellSelIndValue
1300 with { extension "prototype(convert) decode(RAW)" };
1301
Vadim Yanitskiye05d7162020-05-02 16:58:46 +07001302} with { encode "RAW" ; variant "FIELDORDER(msb)" }