blob: 560074ffa4fda07ef33124ce89e278e062ced816 [file] [log] [blame]
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +02001/* TITAN REW encode/decode definitions for 3GPP TS 44.060 RLC/MAC Blocks */
2
3/* (C) 2017-2018 Harald Welte <laforge@gnumonks.org>
4 * (C) 2020 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
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 */
12
13module RLCMAC_Templates {
14 import from General_Types all;
15 import from Osmocom_Types all;
16 import from GSM_Types all;
17 import from RLCMAC_CSN1_Types all;
18 import from RLCMAC_CSN1_Templates all;
19 import from RLCMAC_Types all;
20
21 /* TS 44.060 10.4.5 */
22 function f_rrbp_fn_delay(MacRrbp rrbp) return uint32_t {
23 select (rrbp) {
24 case (RRBP_Nplus13_mod_2715648) { return 13; }
25 case (RRBP_Nplus17_or_18_mod_2715648) { return 17; }
26 case (RRBP_Nplus21_or_22_mod_2715648) { return 21; }
27 case (RRBP_Nplus26_mod_2715648) { return 26; }
28 }
29 return 0;
30 }
31
Vadim Yanitskiy2742bcd2020-05-10 12:45:18 +070032 function f_rrbp_ack_fn(uint32_t current_fn, MacRrbp rrbp)
33 return uint32_t {
34 return (current_fn + f_rrbp_fn_delay(rrbp)) mod 2715648;
35 }
36
Pau Espin Pedrol27d6af52020-04-30 20:13:32 +020037 function f_rlcmac_mcs2headertype(CodingScheme mcs) return EgprsHeaderType {
38 select (mcs) {
39 case (MCS_0) { return RLCMAC_HDR_TYPE_3; }
40 case (MCS_1) { return RLCMAC_HDR_TYPE_3; }
41 case (MCS_2) { return RLCMAC_HDR_TYPE_3; }
42 case (MCS_3) { return RLCMAC_HDR_TYPE_3; }
43 case (MCS_4) { return RLCMAC_HDR_TYPE_3; }
44 case (MCS_5) { return RLCMAC_HDR_TYPE_2; }
45 case (MCS_6) { return RLCMAC_HDR_TYPE_2; }
46 case (MCS_7) { return RLCMAC_HDR_TYPE_1; }
47 case (MCS_8) { return RLCMAC_HDR_TYPE_1; }
48 case (MCS_9) { return RLCMAC_HDR_TYPE_1; }
49 }
50 return RLCMAC_HDR_TYPE_3;
51 }
52
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +020053 function f_rlcmac_cs_mcs2block_len(CodingScheme cs_mcs) return uint32_t {
54 select (cs_mcs) {
55 case (CS_1) { return 23; }
56 case (CS_2) { return 34; }
57 case (CS_3) { return 40; }
58 case (CS_4) { return 54; }
59 case (MCS_1) { return 27; }
60 case (MCS_2) { return 33; }
61 case (MCS_3) { return 42; }
62 case (MCS_4) { return 49; }
63 case (MCS_5) { return 61; }
64 case (MCS_6) { return 79; }
65 case (MCS_7) { return 119; }
66 case (MCS_8) { return 143; }
67 case (MCS_9) { return 155; }
68 }
69 return 0;
70 }
71
72 function f_rlcmac_block_len2cs_mcs(uint32_t len) return CodingScheme {
73 select (len) {
74 case (23) { return CS_1; }
75 case (34) { return CS_2; }
76 case (40) { return CS_3; }
77 case (54) { return CS_4; }
78 case (27) { return MCS_1; }
79 case (33) { return MCS_2; }
80 case (42) { return MCS_3; }
81 case (49) { return MCS_4; }
82 case (60) { return MCS_5; }
83 case (61) { return MCS_5; }
84 case (78) { return MCS_6; }
85 case (79) { return MCS_6; }
86 case (118) { return MCS_7; }
87 case (119) { return MCS_7; }
88 case (142) { return MCS_8; }
89 case (143) { return MCS_8; }
90 case (154) { return MCS_9; }
91 case (155) { return MCS_9; }
92 }
93 return CS_1;
94 }
95
Pau Espin Pedrol245bfcb2020-06-30 20:17:07 +020096 /* Minimum CodingScheme required to fit RLCMAC block */
97 function f_rlcmac_block_len_required_cs_mcs(uint32_t len, boolean is_mcs) return CodingScheme {
98 if (is_mcs) {
99 if (len <= 27) { return MCS_1; }
100 if (len <= 33) { return MCS_2; }
101 if (len <= 42) { return MCS_3; }
102 if (len <= 49) { return MCS_4; }
103 if (len <= 60) { return MCS_5; }
104 if (len <= 61) { return MCS_5; }
105 if (len <= 79) { return MCS_6; }
106 if (len <= 119) { return MCS_7; }
107 if (len <= 143) { return MCS_8; }
108 if (len <= 155) { return MCS_9; }
109 return MCS_1; /* error! */
110 } else {
111 /* 3GPP TS 44.060 Table 10.2.1: RLC data block size, discounting padding in octet */
112 if (len <= 23) { return CS_1; }
113 if (len <= 33) { return CS_2; }
114 if (len <= 39) { return CS_3; }
115 if (len <= 53) { return CS_4; }
116 return CS_1; /* error! */
117 }
118 }
119
Pau Espin Pedrol42acafc2020-05-14 15:18:38 +0200120 function f_rlcmac_block_ChCodingCommand2cs_mcs(ChCodingCommand chcc) return CodingScheme {
121 select (chcc) {
122 case (CH_CODING_CS1) { return CS_1; }
123 case (CH_CODING_CS2) { return CS_2; }
124 case (CH_CODING_CS3) { return CS_3; }
125 case (CH_CODING_CS4) { return CS_4; }
126 }
127 return CS_1;
128 }
129
130 function f_rlcmac_block_EgprsChCodingCommand2cs_mcs(EgprsChCodingCommand echcc) return CodingScheme {
131 select (echcc) {
132 case (CH_CODING_MCS1) { return MCS_1; }
133 case (CH_CODING_MCS2) { return MCS_2; }
134 case (CH_CODING_MCS3) { return MCS_3; }
135 case (CH_CODING_MCS4) { return MCS_4; }
136 case (CH_CODING_MCS5) { return MCS_5; }
137 case (CH_CODING_MCS6) { return MCS_6; }
138 case (CH_CODING_MCS7) { return MCS_7; }
139 case (CH_CODING_MCS8) { return MCS_8; }
140 case (CH_CODING_MCS9) { return MCS_9; }
141 /* CH_CODING_MCS5_7 */
142 /* CH_CODING_MCS6_9 */
143 }
144 return MCS_1;
145 }
146
147 /* 1 -> CS_1 / MCS_1, 2 -> CS_2 / MCS_2, etc. */
148 function f_rlcmac_block_int2cs_mcs(integer n, boolean is_mcs) return CodingScheme {
149 var CodingScheme cs_mcs;
150 if (not is_mcs) {
151 int2enum(n - 1, cs_mcs);
152 return cs_mcs;
153 } else {
154 cs_mcs := MCS_0;
155 int2enum(enum2int(cs_mcs) + n, cs_mcs);
156 return cs_mcs;
157 }
158 }
159
Pau Espin Pedrol27d6af52020-04-30 20:13:32 +0200160 /* Coding and Puncturing Scheme indicator field for Header type 1 in EGPRS TBF or EC TBF or downlink EGPRS2 TBF */
161 function f_rlcmac_cps_htype1_to_mcs(uint3_t cps) return CodingScheme {
162 var CodingSchemeArray egprs_Header_type1_coding_puncturing_scheme_to_mcs := {
163 MCS_9 /* 0x00, "(MCS-9/P1 ; MCS-9/P1)" */,
164 MCS_9 /* 0x01, "(MCS-9/P1 ; MCS-9/P2)" */,
165 MCS_9 /* 0x02, "(MCS-9/P1 ; MCS-9/P3)" */,
166 MCS_0 /* 0x03, "reserved" */,
167 MCS_9 /* 0x04, "(MCS-9/P2 ; MCS-9/P1)" */,
168 MCS_9 /* 0x05, "(MCS-9/P2 ; MCS-9/P2)" */,
169 MCS_9 /* 0x06, "(MCS-9/P2 ; MCS-9/P3)" */,
170 MCS_0 /* 0x07, "reserved" */,
171 MCS_9 /* 0x08, "(MCS-9/P3 ; MCS-9/P1)" */,
172 MCS_9 /* 0x09, "(MCS-9/P3 ; MCS-9/P2)" */,
173 MCS_9 /* 0x0A, "(MCS-9/P3 ; MCS-9/P3)" */,
174 MCS_8 /* 0x0B, "(MCS-8/P1 ; MCS-8/P1)" */,
175 MCS_8 /* 0x0C, "(MCS-8/P1 ; MCS-8/P2)" */,
176 MCS_8 /* 0x0D, "(MCS-8/P1 ; MCS-8/P3)" */,
177 MCS_8 /* 0x0E, "(MCS-8/P2 ; MCS-8/P1)" */,
178 MCS_8 /* 0x0F, "(MCS-8/P2 ; MCS-8/P2)" */,
179 MCS_8 /* 0x10, "(MCS-8/P2 ; MCS-8/P3)" */,
180 MCS_8 /* 0x11, "(MCS-8/P3 ; MCS-8/P1)" */,
181 MCS_8 /* 0x12, "(MCS-8/P3 ; MCS-8/P2)" */,
182 MCS_8 /* 0x13, "(MCS-8/P3 ; MCS-8/P3)" */,
183 MCS_7 /* 0x14, "(MCS-7/P1 ; MCS-7/P1)" */,
184 MCS_7 /* 0x15, "(MCS-7/P1 ; MCS-7/P2)" */,
185 MCS_7 /* 0x16, "(MCS-7/P1 ; MCS-7/P3)" */,
186 MCS_7 /* 0x17, "(MCS-7/P2 ; MCS-7/P1)" */,
187 MCS_7 /* 0x18, "(MCS-7/P2 ; MCS-7/P2)" */,
188 MCS_7 /* 0x19, "(MCS-7/P2 ; MCS-7/P3)" */,
189 MCS_7 /* 0x1A, "(MCS-7/P3 ; MCS-7/P1)" */,
190 MCS_7 /* 0x1B, "(MCS-7/P3 ; MCS-7/P2)" */,
191 MCS_7 /* 0x1C, "(MCS-7/P3 ; MCS-7/P3)" */,
192 MCS_0 /* 0x1D, "reserved" */,
193 MCS_0 /* 0x1E, "reserved" */,
194 MCS_0 /* 0x1F, "reserved" */
195 };
196 return egprs_Header_type1_coding_puncturing_scheme_to_mcs[cps];
197 }
198
199 /* Coding and Puncturing Scheme indicator field for Header type 2 in (EC-)EGPRS TBF or uplink EGPRS2-A TBF */
200 function f_rlcmac_cps_htype2_to_mcs(uint3_t cps) return CodingScheme {
201 var CodingSchemeArray egprs_Header_type2_coding_puncturing_scheme_to_mcs := {
202 MCS_6 /* {0x00, "MCS-6/P1"} */,
203 MCS_6 /* {0x01, "MCS-6/P2"} */,
204 MCS_6 /* {0x02, "MCS-6/P1 with 6 octet padding"} */,
205 MCS_6 /* {0x03, "MCS-6/P2 with 6 octet padding "} */,
206 MCS_5 /* {0x04, "MCS-5/P1"} */,
207 MCS_5 /* {0x05, "MCS-5/P2"} */,
208 MCS_5 /* {0x06, "MCS-6/P1 with 10 octet padding "} */,
209 MCS_5 /* {0x07, "MCS-6/P2 with 10 octet padding "} */
210 };
211 return egprs_Header_type2_coding_puncturing_scheme_to_mcs[cps];
212 }
213
214 /* Coding and Puncturing Scheme indicator field for Header type 3 */
215 function f_rlcmac_cps_htype3_to_mcs(uint3_t cps) return CodingScheme {
216 var CodingSchemeArray egprs_Header_type3_coding_puncturing_scheme_to_mcs := {
217 MCS_4 /* {0x00, "MCS-4/P1"} */,
218 MCS_4 /* {0x01, "MCS-4/P2"} */,
219 MCS_4 /* {0x02, "MCS-4/P3"} */,
220 MCS_3 /* {0x03, "MCS-3/P1"} */,
221 MCS_3 /* {0x04, "MCS-3/P2"} */,
222 MCS_3 /* {0x05, "MCS-3/P3"} */,
223 MCS_3 /* {0x06, "MCS-3/P1 with padding"} */,
224 MCS_3 /* {0x07, "MCS-3/P2 with padding"} */,
225 MCS_3 /* {0x08, "MCS-3/P3 with padding"} */,
226 MCS_2 /* {0x09, "MCS-2/P1"} */,
227 MCS_2 /* {0x0A, "MCS-2/P2"} */,
228 MCS_1 /* {0x0B, "MCS-1/P1"} */,
229 MCS_1 /* {0x0C, "MCS-1/P2"} */,
230 MCS_2 /* {0x0D, "MCS-2/P1 with padding"} */,
231 MCS_2 /* {0x0E, "MCS-2/P2 with padding"} */,
232 MCS_0 /* {0x0F, "MCS-0"} */
233 };
234 return egprs_Header_type3_coding_puncturing_scheme_to_mcs[cps];
235 }
236
237 function f_rlcmac_cps_htype_to_mcs(uint3_t cps, EgprsHeaderType htype) return CodingScheme {
238 select (htype) {
239 case (RLCMAC_HDR_TYPE_1) { return f_rlcmac_cps_htype1_to_mcs(cps); }
240 case (RLCMAC_HDR_TYPE_2) { return f_rlcmac_cps_htype2_to_mcs(cps); }
241 case (RLCMAC_HDR_TYPE_3) { return f_rlcmac_cps_htype3_to_mcs(cps); }
242 }
243 //TODO: return error here.
244 return CS_1;
245 }
246
247 function f_rlcmac_mcs_to_cps_htype1(CodingScheme mcs, uint2_t part, boolean with_padding) return uint5_t {
248 //TODO: implement similar to f_rlcmac_mcs_to_cps_htype3()
249 //TODO: return error here.
250 return 0;
251 }
252
253 function f_rlcmac_mcs_to_cps_htype2(CodingScheme mcs, uint2_t part, boolean with_padding) return uint5_t {
254 //TODO: implement similar to f_rlcmac_mcs_to_cps_htype3()
255 //TODO: return error here.
256 return 0;
257 }
258
259 function f_rlcmac_mcs_to_cps_htype3(CodingScheme mcs, uint2_t part, boolean with_padding) return uint5_t {
260 select (mcs) {
261 case (MCS_4) {
262 select (part) {
263 case (1) { return 0; /* {0x00, "MCS-4/P1"} */ }
264 case (2) { return 1; /* {0x01, "MCS-4/P2"} */ }
265 case (3) { return 2; /* {0x01, "MCS-4/P2"} */ }
266 }
267 }
268 case (MCS_3) {
269 if (not with_padding) {
270 select (part) {
271 case (1) { return 3; /* {0x03, "MCS-3/P1"} */ }
272 case (2) { return 4; /* {0x04, "MCS-3/P2"} */ }
273 case (3) { return 5; /* {0x05, "MCS-3/P3"} */ }
274 }
275 } else {
276 select (part) {
277 case (1) { return 6; /* {0x06, "MCS-3/P1 with padding"} */ }
278 case (2) { return 7; /* {0x07, "MCS-3/P2 with padding"} */ }
279 case (3) { return 8; /* {0x08, "MCS-3/P3 with padding"} */ }
280 }
281 }
282 }
283 case (MCS_2) {
284 if (not with_padding) {
285 select (part) {
286 case (1) { return 9; /* {0x09, "MCS-2/P1"} */ }
287 case (2) { return 10; /* {0x0A, "MCS-2/P2"} */ }
288 }
289 } else {
290 select (part) {
291 case (1) { return 13; /* {0x0D, "MCS-2/P1 with padding"} */ }
292 case (2) { return 14; /* {0x0E, "MCS-2/P2 with padding"} */}
293 }
294 }
295 }
296 case (MCS_1) {
297 select (part) {
298 case (1) { return 11; /* {0x0B, "MCS-1/P1"} */ }
299 case (2) { return 12; /* {0x0C, "MCS-1/P2"} */ }
300 }
301 }
302 case (MCS_0) { return 15; /* {0x0F, "MCS-0"} */ }
303 }
304 //TODO: return error here.
305 return 0;
306 }
307
308 function f_rlcmac_mcs_to_cps(CodingScheme mcs, uint2_t part, boolean with_padding := false) return uint5_t {
309
310 var EgprsHeaderType htype := f_rlcmac_mcs2headertype(mcs);
311 select (htype) {
312 case (RLCMAC_HDR_TYPE_1) { return f_rlcmac_mcs_to_cps_htype1(mcs, part, with_padding); }
313 case (RLCMAC_HDR_TYPE_2) { return f_rlcmac_mcs_to_cps_htype2(mcs, part, with_padding); }
314 case (RLCMAC_HDR_TYPE_3) { return f_rlcmac_mcs_to_cps_htype3(mcs, part, with_padding); }
315 }
316 //TODO: return error here.
317 return 0;
318 }
319
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200320 template (value) RlcmacUlBlock ts_RLC_UL_CTRL_ACK(RlcmacUlCtrlMsg ctrl,
321 MacPayloadType pt := MAC_PT_RLCMAC_NO_OPT,
322 boolean retry := false) := {
323 ctrl := {
324 mac_hdr := {
325 payload_type := pt,
326 spare := '00000'B,
327 retry := retry
328 },
329 payload := ctrl
330 }
331 }
332
333 /* Send Template for Downlink ACK/NACK */
334 template RlcmacUlBlock ts_RLCMAC_DL_ACK_NACK(template uint5_t tfi, AckNackDescription andesc, boolean retry := false) := {
335 ctrl := {
336 mac_hdr := {
337 payload_type := MAC_PT_RLCMAC_NO_OPT,
338 spare := '00000'B,
339 retry := retry
340 },
341 payload := {
342 msg_type := PACKET_DL_ACK_NACK,
343 u := {
344 dl_ack_nack := {
345 dl_tfi := tfi,
346 ack_nack_desc := andesc,
347 chreq_desc_presence := '0'B,
348 chreq_desc := omit,
349 ch_qual_rep := c_ChQualRep_default
350 }
351 }
352 }
353 }
354 }
355
Pau Espin Pedrol6791eb62020-05-20 18:27:10 +0200356 template RlcmacUlBlock ts_RLCMAC_DL_ACK_NACK_CHREQ(template uint5_t tfi,
357 AckNackDescription andesc,
358 boolean retry := false,
359 template ChannelReqDescription chreq_desc := c_ChReqDesc_default)
360 modifies ts_RLCMAC_DL_ACK_NACK := {
361 ctrl := {
362 payload := {
363 u := {
364 dl_ack_nack := {
365 chreq_desc_presence := '1'B,
366 chreq_desc := chreq_desc
367 }
368 }
369 }
370 }
371 }
372
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200373 /* Template for uplink Data block */
374 template RlcmacUlBlock t_RLCMAC_UL_DATA(template uint5_t tfi, template uint4_t cv, template uint7_t bsn,
375 template LlcBlocks blocks := {}, template boolean stall := false) := {
376 data := {
377 mac_hdr := {
378 payload_type := MAC_PT_RLC_DATA,
379 countdown := cv,
380 stall_ind := false,
381 retry := false,
382 spare := '0'B,
383 pfi_ind := false,
384 tfi := tfi,
385 tlli_ind := false,
386 bsn := bsn,
387 e := false
388 },
389 tlli := omit,
390 pfi := omit,
391 blocks := blocks
392 }
393 }
394 template RlcmacUlBlock t_RLCMAC_UL_DATA_TLLI(template uint5_t tfi, template uint4_t cv, template uint7_t bsn,
395 template LlcBlocks blocks := {}, template boolean stall := false, template GprsTlli tlli) := {
396 data := {
397 mac_hdr := {
398 payload_type := MAC_PT_RLC_DATA,
399 countdown := cv,
400 stall_ind := false,
401 retry := false,
402 spare := '0'B,
403 pfi_ind := false,
404 tfi := tfi,
405 tlli_ind := true,
406 bsn := bsn,
407 e := false
408 },
409 tlli := tlli,
410 pfi := omit,
411 blocks := blocks
412 }
413 }
414
Pau Espin Pedrol2456dad2020-04-30 20:22:38 +0200415 /* Template for uplink Data block */
416 template RlcmacUlBlock t_RLCMAC_UL_EGPRS_DATA(CodingScheme mcs,
417 template uint5_t tfi, template uint4_t cv,
418 template uint11_t bsn1, template EgprsLlcBlocks blocks := {}) := {
419 data_egprs := {
420 mac_hdr := {
421 header_type := f_rlcmac_mcs2headertype(mcs),
422 tfi := tfi,
423 countdown := cv,
424 foi_si := '0'B,
425 r_ri := '0'B,
426 bsn1 := bsn1,
427 cps := f_rlcmac_mcs_to_cps(mcs, 1, false),
428 pfi_ind := false,
429 rsb := '0'B,
430 spb := '00'B
431 },
432 tlli_ind := false,
433 e := false,
434 tlli := omit,
435 pfi := omit,
436 blocks := blocks
437 }
438 }
439
Vadim Yanitskiy0a9b1482020-05-10 14:43:21 +0700440 template DlMacHeader t_RLCMAC_DlMacH(template (present) MacPayloadType pt,
441 template (present) boolean rrbp_valid,
442 template (present) MacRrbp rrbp,
443 template (present) uint3_t usf) := {
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200444 payload_type := pt,
445 rrbp := rrbp,
Vadim Yanitskiy0a9b1482020-05-10 14:43:21 +0700446 rrbp_valid := rrbp_valid,
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200447 usf := usf
448 }
449
450 template RlcmacDlBlock tr_RLCMAC_DUMMY_CTRL(template uint3_t usf := ?, template PageMode page_mode := ?) := {
451 ctrl := {
452 mac_hdr := {
453 payload_type := (MAC_PT_RLCMAC_NO_OPT, MAC_PT_RLCMAC_OPT),
454 rrbp:= ?,
455 rrbp_valid := ?,
456 usf := usf
457 },
458 opt := *,
459 payload := {
460 msg_type := PACKET_DL_DUMMY_CTRL,
461 u := {
462 dl_dummy := {
463 page_mode := page_mode,
464 persistence_levels_present := ?,
465 persistence_levels := *
466 }
467 }
468 }
469 }
470 }
471
472 template RlcmacDlBlock tr_RLCMAC_DL_PACKET_ASS(template uint3_t usf := ?) := {
473 ctrl := {
474 mac_hdr := {
475 payload_type := (MAC_PT_RLCMAC_NO_OPT, MAC_PT_RLCMAC_OPT),
476 rrbp:= ?,
477 rrbp_valid := ?,
478 usf := usf
479 },
480 opt := *,
481 payload := {
482 msg_type := PACKET_DL_ASSIGNMENT,
483 u := {
484 dl_assignment := {
485 page_mode := ?,
486 pres1 := ?,
487 persistence_levels := *,
Pau Espin Pedrol984d09f2020-05-19 18:51:58 +0200488 tfi_or_tlli := ?,
489 egprs2 := '0'B,
490 mac_mode := ?,
491 rlc_mode := ?,
492 control_ack := ?,
493 timeslot_alloc := ?,
494 pkt_ta := ?,
495 p0_present := ?,
496 p0 := *,
497 reserved := *,
498 pr_mode := *,
499 freq_par_present := ?,
500 freq_par := *,
501 dl_tfi_ass_present := ?,
502 dl_tfi_assignment := *,
503 pwr_ctrl_present := ?,
504 pwr_ctrl := *,
505 tbf_starting_time_present := ?,
506 tbf_starting_time := *,
507 release1999 := '1'B,
508 sub_present := ?,
509 sub := *,
510 pkt_ext_ta_present := ?,
511 pkt_ext_ta := *,
512 compact_reduced_ma_present := ?,
513 compact_reduced_ma := *
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200514 }
515 }
516 }
517 }
518 }
519
520 template RlcmacDlBlock tr_RLCMAC_UL_PACKET_ASS(template uint3_t usf := ?) := {
521 ctrl := {
522 mac_hdr := {
523 payload_type := (MAC_PT_RLCMAC_NO_OPT, MAC_PT_RLCMAC_OPT),
524 rrbp:= ?,
525 rrbp_valid := ?,
526 usf := usf
527 },
528 opt := *,
529 payload := {
530 msg_type := PACKET_UL_ASSIGNMENT,
531 u := {
532 ul_assignment := {
533 page_mode := ?,
534 persistence_levels_present := ?,
535 persistence_levels := *,
536 identity := ?,
537 is_egprs := ?, /* msg escape */
Pau Espin Pedrol45b664b2020-05-14 15:16:40 +0200538 gprs := *,
539 egprs := *
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200540 }
541 }
542 }
543 }
544 }
545
Pau Espin Pedrol02c972d2020-05-13 15:56:16 +0200546 template RlcmacDlBlock tr_RLCMAC_UL_PACKET_ASS_GPRS(template uint3_t usf := ?, template PktUlAssGprs gprs := ?)
547 modifies tr_RLCMAC_UL_PACKET_ASS := {
548 ctrl := {
549 payload := {
550 u := {
551 ul_assignment := {
552 is_egprs := '0'B,
Pau Espin Pedrol45b664b2020-05-14 15:16:40 +0200553 gprs := gprs,
554 egprs := omit
555 }
556 }
557 }
558 }
559 }
560
561 template RlcmacDlBlock tr_RLCMAC_UL_PACKET_ASS_EGPRS(template uint3_t usf := ?, template PktUlAssEgprs egprs := ?)
562 modifies tr_RLCMAC_UL_PACKET_ASS := {
563 ctrl := {
564 payload := {
565 u := {
566 ul_assignment := {
567 is_egprs := '1'B,
568 gprs := omit,
569 egprs := egprs
Pau Espin Pedrol02c972d2020-05-13 15:56:16 +0200570 }
571 }
572 }
573 }
574 }
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200575
576 /* Receive Template for Uplink ACK/NACK */
Pau Espin Pedrol692222c2020-05-17 00:25:37 +0200577 template RlcmacDlBlock tr_RLCMAC_UL_ACK_NACK(template uint5_t ul_tfi) := {
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200578 ctrl := {
579 mac_hdr := {
580 payload_type := (MAC_PT_RLCMAC_NO_OPT, MAC_PT_RLCMAC_OPT),
581 rrbp:= ?,
582 rrbp_valid := ?,
583 usf := ?
584 },
585 opt := *,
586 payload := {
587 msg_type := PACKET_UL_ACK_NACK,
588 u := {
589 ul_ack_nack := {
590 page_mode := ?,
591 msg_excape := ?,
592 uplink_tfi := ul_tfi,
Pau Espin Pedrol692222c2020-05-17 00:25:37 +0200593 is_egprs := ?,
594 gprs := *,
595 egprs := *
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200596 }
597 }
598 }
599 }
Pau Espin Pedrol692222c2020-05-17 00:25:37 +0200600 };
601
602 template RlcmacDlBlock tr_RLCMAC_UL_ACK_NACK_GPRS(template uint5_t ul_tfi, template UlAckNackGprs gprs := tr_UlAckNackGprs(*))
603 modifies tr_RLCMAC_UL_ACK_NACK := {
604 ctrl := {
605 payload := {
606 u := {
607 ul_ack_nack := {
608 is_egprs := '0'B,
609 gprs := gprs,
610 egprs := omit
611 }
612 }
613 }
614 }
615 };
616
617 template RlcmacDlBlock tr_RLCMAC_UL_ACK_NACK_EGPRS(template uint5_t ul_tfi, template UlAckNackEgprs egprs := tr_UlAckNackEgprs(*))
618 modifies tr_RLCMAC_UL_ACK_NACK := {
619 ctrl := {
620 payload := {
621 u := {
622 ul_ack_nack := {
623 is_egprs := '1'B,
624 gprs := omit,
625 egprs := egprs
626 }
627 }
628 }
629 }
630 };
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200631
632 template RlcmacDlBlock tr_RLCMAC_PACKET_PAG_REQ(template uint3_t usf := ?) := {
633 ctrl := {
634 mac_hdr := {
635 payload_type := MAC_PT_RLCMAC_NO_OPT,
636 rrbp:= ?,
637 rrbp_valid := ?,
638 usf := usf
639 },
640 opt := *,
641 payload := {
642 msg_type := PACKET_PAGING_REQUEST,
643 u := {
644 paging := {
645 page_mode := ?,
646 persistence_levels_present := ?,
647 persistence_levels := *,
648 nln_present := ?,
649 nln := *,
650 repeated_pageinfo_present := ?,
651 repeated_pageinfo := *
652 }
653 }
654 }
655 }
656 }
657
Vadim Yanitskiyb6733a62020-05-10 14:39:00 +0700658 /* Either GPRS or EGPRS data block with arbitrary contents */
659 template RlcmacDlBlock tr_RLCMAC_DATA := (tr_RLCMAC_DATA_GPRS, tr_RLCMAC_DATA_EGPRS);
660
Vadim Yanitskiyd4f22aa2020-05-10 13:13:46 +0700661 template RlcmacDlBlock tr_RLCMAC_DATA_GPRS(template (present) boolean rrbp_valid := ?,
662 template (present) MacRrbp rrbp := ?,
663 template (present) uint3_t usf := ?) := {
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200664 data := {
665 mac_hdr := {
666 mac_hdr := {
667 payload_type := MAC_PT_RLC_DATA,
Vadim Yanitskiyd4f22aa2020-05-10 13:13:46 +0700668 rrbp := rrbp,
669 rrbp_valid := rrbp_valid,
670 usf := usf
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200671 },
672 hdr_ext := ?
673 },
674 blocks := ?
675 }
676 }
677
678 template RlcmacDlBlock tr_RLCMAC_DATA_EGPRS := {
679 data_egprs := {
680 mac_hdr := ?,
681 fbi := ?,
682 e := ?,
683 blocks := ?
684 }
685 }
686
687 /* Template for Uplink MAC Control Header */
688 template UlMacCtrlHeader t_RLCMAC_UlMacCtrlH(template MacPayloadType pt, template boolean retry := false) := {
689 payload_type := pt,
690 spare := '00000'B,
691 retry := retry
692 }
693
694 /* Template for Uplink Control ACK */
695 template RlcmacUlBlock ts_RLCMAC_CTRL_ACK(GprsTlli tlli, CtrlAck ack := MS_RCVD_TWO_RLC_SAME_RTI_DIFF_RBSN) := {
696 ctrl := {
697 mac_hdr := t_RLCMAC_UlMacCtrlH(MAC_PT_RLCMAC_NO_OPT),
698 payload := {
699 msg_type := PACKET_CONTROL_ACK,
700 u := {
701 ctrl_ack := {
702 tlli := tlli,
703 ctrl_ack := ack
704 }
705 }
706 }
707 }
708 }
709
Pau Espin Pedrol05b6c172020-06-26 17:28:23 +0200710 template LlcBlockHdr t_RLCMAC_LLCBLOCK_HDR(uint16_t length_ind, boolean more, boolean e) := {
711 length_ind := length_ind,
712 more := more, /* 1 = new LLC PDU starts */
713 e := e /* 0 = another extension octet after LLC PDU, 1 = no more extension octets */
714 }
715
716 template EgprsLlcBlockHdr t_RLCMAC_LLCBLOCK_EGPRS_HDR(uint16_t length_ind, boolean e) := {
717 length_ind := length_ind,
718 e := e /* 0 = another extension octet after LLC PDU, 1 = no more extension octets */
719 }
720
721 /* Template for a LlcBlock (part of a LLC frame inside RlcMacDlDataBlock */
722 template LlcBlock t_RLCMAC_LLCBLOCK(octetstring data, template (omit) LlcBlockHdr llc_hdr := omit) := {
723 hdr := llc_hdr, /* omit = let encoder figure out the header */
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200724 payload := data
725 }
726
Pau Espin Pedrol2456dad2020-04-30 20:22:38 +0200727 /* Template for a LlcBlock (part of a LLC frame inside RlcMacEgprs?lDataBlock */
Pau Espin Pedrol05b6c172020-06-26 17:28:23 +0200728 template EgprsLlcBlock t_RLCMAC_LLCBLOCK_EGPRS(octetstring data, template (omit) EgprsLlcBlockHdr llc_hdr := omit) := {
Pau Espin Pedrol2456dad2020-04-30 20:22:38 +0200729 /* let encoder figure out the header */
Pau Espin Pedrol05b6c172020-06-26 17:28:23 +0200730 hdr := llc_hdr, /* omit = let encoder figure out the header */
Pau Espin Pedrol2456dad2020-04-30 20:22:38 +0200731 payload := data
732 }
733
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200734} with { encode "RAW"; variant "FIELDORDER(msb)" }