blob: f016c4dd8ee7505fca76e08351f3059f7be0f2da [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
Pau Espin Pedrol4fbeefd2020-11-05 13:47:24 +010021 template CodingScheme cs_gprs_any := (CS_1, CS_2, CS_3, CS_4);
22 template CodingScheme mcs_egprs_any := (MCS_1, MCS_2, MCS_3, MCS_4, MCS_5,
23 MCS_6, MCS_7, MCS_8, MCS_9);
24
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +020025 /* TS 44.060 10.4.5 */
26 function f_rrbp_fn_delay(MacRrbp rrbp) return uint32_t {
27 select (rrbp) {
28 case (RRBP_Nplus13_mod_2715648) { return 13; }
29 case (RRBP_Nplus17_or_18_mod_2715648) { return 17; }
30 case (RRBP_Nplus21_or_22_mod_2715648) { return 21; }
31 case (RRBP_Nplus26_mod_2715648) { return 26; }
32 }
33 return 0;
34 }
35
Vadim Yanitskiy2742bcd2020-05-10 12:45:18 +070036 function f_rrbp_ack_fn(uint32_t current_fn, MacRrbp rrbp)
37 return uint32_t {
38 return (current_fn + f_rrbp_fn_delay(rrbp)) mod 2715648;
39 }
40
Pau Espin Pedrolcb00c522020-11-06 19:52:05 +010041 function f_rlcmac_cs_mcs_is_mcs(CodingScheme cs_mcs) return boolean {
42 if (cs_mcs >= MCS_0) {
43 return true;
44 }
45 return false;
46 }
47
Pau Espin Pedrol27d6af52020-04-30 20:13:32 +020048 function f_rlcmac_mcs2headertype(CodingScheme mcs) return EgprsHeaderType {
49 select (mcs) {
50 case (MCS_0) { return RLCMAC_HDR_TYPE_3; }
51 case (MCS_1) { return RLCMAC_HDR_TYPE_3; }
52 case (MCS_2) { return RLCMAC_HDR_TYPE_3; }
53 case (MCS_3) { return RLCMAC_HDR_TYPE_3; }
54 case (MCS_4) { return RLCMAC_HDR_TYPE_3; }
55 case (MCS_5) { return RLCMAC_HDR_TYPE_2; }
56 case (MCS_6) { return RLCMAC_HDR_TYPE_2; }
57 case (MCS_7) { return RLCMAC_HDR_TYPE_1; }
58 case (MCS_8) { return RLCMAC_HDR_TYPE_1; }
59 case (MCS_9) { return RLCMAC_HDR_TYPE_1; }
60 }
61 return RLCMAC_HDR_TYPE_3;
62 }
63
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +020064 function f_rlcmac_cs_mcs2block_len(CodingScheme cs_mcs) return uint32_t {
65 select (cs_mcs) {
66 case (CS_1) { return 23; }
67 case (CS_2) { return 34; }
68 case (CS_3) { return 40; }
69 case (CS_4) { return 54; }
70 case (MCS_1) { return 27; }
71 case (MCS_2) { return 33; }
72 case (MCS_3) { return 42; }
73 case (MCS_4) { return 49; }
74 case (MCS_5) { return 61; }
75 case (MCS_6) { return 79; }
76 case (MCS_7) { return 119; }
77 case (MCS_8) { return 143; }
78 case (MCS_9) { return 155; }
79 }
80 return 0;
81 }
82
83 function f_rlcmac_block_len2cs_mcs(uint32_t len) return CodingScheme {
84 select (len) {
85 case (23) { return CS_1; }
86 case (34) { return CS_2; }
87 case (40) { return CS_3; }
88 case (54) { return CS_4; }
89 case (27) { return MCS_1; }
90 case (33) { return MCS_2; }
91 case (42) { return MCS_3; }
92 case (49) { return MCS_4; }
93 case (60) { return MCS_5; }
94 case (61) { return MCS_5; }
95 case (78) { return MCS_6; }
96 case (79) { return MCS_6; }
97 case (118) { return MCS_7; }
98 case (119) { return MCS_7; }
99 case (142) { return MCS_8; }
100 case (143) { return MCS_8; }
101 case (154) { return MCS_9; }
102 case (155) { return MCS_9; }
103 }
104 return CS_1;
105 }
106
Pau Espin Pedrolcb00c522020-11-06 19:52:05 +0100107 function f_rlcmac_cs_mcs2block_len_no_spare_bits(CodingScheme cs_mcs) return uint32_t {
108 select (cs_mcs) {
109 /* 3GPP TS 44.060 Table 10.2.1: RLC data block size, discounting padding in octet */
110 case (CS_1) { return 23; }
111 case (CS_2) { return 33; }
112 case (CS_3) { return 39; }
113 case (CS_4) { return 53; }
114 case (MCS_1) { return 27; }
115 case (MCS_2) { return 33; }
116 case (MCS_3) { return 42; }
117 case (MCS_4) { return 49; }
118 case (MCS_5) { return 61; }
119 case (MCS_6) { return 79; }
120 case (MCS_7) { return 119; }
121 case (MCS_8) { return 143; }
122 case (MCS_9) { return 155; }
123 }
124 return 0;
125 }
126
127 /* Minimum CodingScheme required to fit RLCMAC block. Spare bits not counted. */
Pau Espin Pedrol245bfcb2020-06-30 20:17:07 +0200128 function f_rlcmac_block_len_required_cs_mcs(uint32_t len, boolean is_mcs) return CodingScheme {
129 if (is_mcs) {
130 if (len <= 27) { return MCS_1; }
131 if (len <= 33) { return MCS_2; }
132 if (len <= 42) { return MCS_3; }
133 if (len <= 49) { return MCS_4; }
134 if (len <= 60) { return MCS_5; }
135 if (len <= 61) { return MCS_5; }
136 if (len <= 79) { return MCS_6; }
137 if (len <= 119) { return MCS_7; }
138 if (len <= 143) { return MCS_8; }
139 if (len <= 155) { return MCS_9; }
140 return MCS_1; /* error! */
141 } else {
142 /* 3GPP TS 44.060 Table 10.2.1: RLC data block size, discounting padding in octet */
143 if (len <= 23) { return CS_1; }
144 if (len <= 33) { return CS_2; }
145 if (len <= 39) { return CS_3; }
146 if (len <= 53) { return CS_4; }
147 return CS_1; /* error! */
148 }
149 }
150
Pau Espin Pedrol42acafc2020-05-14 15:18:38 +0200151 function f_rlcmac_block_ChCodingCommand2cs_mcs(ChCodingCommand chcc) return CodingScheme {
152 select (chcc) {
153 case (CH_CODING_CS1) { return CS_1; }
154 case (CH_CODING_CS2) { return CS_2; }
155 case (CH_CODING_CS3) { return CS_3; }
156 case (CH_CODING_CS4) { return CS_4; }
157 }
158 return CS_1;
159 }
160
161 function f_rlcmac_block_EgprsChCodingCommand2cs_mcs(EgprsChCodingCommand echcc) return CodingScheme {
162 select (echcc) {
163 case (CH_CODING_MCS1) { return MCS_1; }
164 case (CH_CODING_MCS2) { return MCS_2; }
165 case (CH_CODING_MCS3) { return MCS_3; }
166 case (CH_CODING_MCS4) { return MCS_4; }
167 case (CH_CODING_MCS5) { return MCS_5; }
168 case (CH_CODING_MCS6) { return MCS_6; }
169 case (CH_CODING_MCS7) { return MCS_7; }
170 case (CH_CODING_MCS8) { return MCS_8; }
171 case (CH_CODING_MCS9) { return MCS_9; }
172 /* CH_CODING_MCS5_7 */
173 /* CH_CODING_MCS6_9 */
174 }
175 return MCS_1;
176 }
177
178 /* 1 -> CS_1 / MCS_1, 2 -> CS_2 / MCS_2, etc. */
179 function f_rlcmac_block_int2cs_mcs(integer n, boolean is_mcs) return CodingScheme {
180 var CodingScheme cs_mcs;
181 if (not is_mcs) {
182 int2enum(n - 1, cs_mcs);
183 return cs_mcs;
184 } else {
185 cs_mcs := MCS_0;
186 int2enum(enum2int(cs_mcs) + n, cs_mcs);
187 return cs_mcs;
188 }
189 }
190
Pau Espin Pedrol27d6af52020-04-30 20:13:32 +0200191 /* Coding and Puncturing Scheme indicator field for Header type 1 in EGPRS TBF or EC TBF or downlink EGPRS2 TBF */
192 function f_rlcmac_cps_htype1_to_mcs(uint3_t cps) return CodingScheme {
193 var CodingSchemeArray egprs_Header_type1_coding_puncturing_scheme_to_mcs := {
194 MCS_9 /* 0x00, "(MCS-9/P1 ; MCS-9/P1)" */,
195 MCS_9 /* 0x01, "(MCS-9/P1 ; MCS-9/P2)" */,
196 MCS_9 /* 0x02, "(MCS-9/P1 ; MCS-9/P3)" */,
197 MCS_0 /* 0x03, "reserved" */,
198 MCS_9 /* 0x04, "(MCS-9/P2 ; MCS-9/P1)" */,
199 MCS_9 /* 0x05, "(MCS-9/P2 ; MCS-9/P2)" */,
200 MCS_9 /* 0x06, "(MCS-9/P2 ; MCS-9/P3)" */,
201 MCS_0 /* 0x07, "reserved" */,
202 MCS_9 /* 0x08, "(MCS-9/P3 ; MCS-9/P1)" */,
203 MCS_9 /* 0x09, "(MCS-9/P3 ; MCS-9/P2)" */,
204 MCS_9 /* 0x0A, "(MCS-9/P3 ; MCS-9/P3)" */,
205 MCS_8 /* 0x0B, "(MCS-8/P1 ; MCS-8/P1)" */,
206 MCS_8 /* 0x0C, "(MCS-8/P1 ; MCS-8/P2)" */,
207 MCS_8 /* 0x0D, "(MCS-8/P1 ; MCS-8/P3)" */,
208 MCS_8 /* 0x0E, "(MCS-8/P2 ; MCS-8/P1)" */,
209 MCS_8 /* 0x0F, "(MCS-8/P2 ; MCS-8/P2)" */,
210 MCS_8 /* 0x10, "(MCS-8/P2 ; MCS-8/P3)" */,
211 MCS_8 /* 0x11, "(MCS-8/P3 ; MCS-8/P1)" */,
212 MCS_8 /* 0x12, "(MCS-8/P3 ; MCS-8/P2)" */,
213 MCS_8 /* 0x13, "(MCS-8/P3 ; MCS-8/P3)" */,
214 MCS_7 /* 0x14, "(MCS-7/P1 ; MCS-7/P1)" */,
215 MCS_7 /* 0x15, "(MCS-7/P1 ; MCS-7/P2)" */,
216 MCS_7 /* 0x16, "(MCS-7/P1 ; MCS-7/P3)" */,
217 MCS_7 /* 0x17, "(MCS-7/P2 ; MCS-7/P1)" */,
218 MCS_7 /* 0x18, "(MCS-7/P2 ; MCS-7/P2)" */,
219 MCS_7 /* 0x19, "(MCS-7/P2 ; MCS-7/P3)" */,
220 MCS_7 /* 0x1A, "(MCS-7/P3 ; MCS-7/P1)" */,
221 MCS_7 /* 0x1B, "(MCS-7/P3 ; MCS-7/P2)" */,
222 MCS_7 /* 0x1C, "(MCS-7/P3 ; MCS-7/P3)" */,
223 MCS_0 /* 0x1D, "reserved" */,
224 MCS_0 /* 0x1E, "reserved" */,
225 MCS_0 /* 0x1F, "reserved" */
226 };
227 return egprs_Header_type1_coding_puncturing_scheme_to_mcs[cps];
228 }
229
230 /* Coding and Puncturing Scheme indicator field for Header type 2 in (EC-)EGPRS TBF or uplink EGPRS2-A TBF */
231 function f_rlcmac_cps_htype2_to_mcs(uint3_t cps) return CodingScheme {
232 var CodingSchemeArray egprs_Header_type2_coding_puncturing_scheme_to_mcs := {
233 MCS_6 /* {0x00, "MCS-6/P1"} */,
234 MCS_6 /* {0x01, "MCS-6/P2"} */,
235 MCS_6 /* {0x02, "MCS-6/P1 with 6 octet padding"} */,
236 MCS_6 /* {0x03, "MCS-6/P2 with 6 octet padding "} */,
237 MCS_5 /* {0x04, "MCS-5/P1"} */,
238 MCS_5 /* {0x05, "MCS-5/P2"} */,
239 MCS_5 /* {0x06, "MCS-6/P1 with 10 octet padding "} */,
240 MCS_5 /* {0x07, "MCS-6/P2 with 10 octet padding "} */
241 };
242 return egprs_Header_type2_coding_puncturing_scheme_to_mcs[cps];
243 }
244
245 /* Coding and Puncturing Scheme indicator field for Header type 3 */
246 function f_rlcmac_cps_htype3_to_mcs(uint3_t cps) return CodingScheme {
247 var CodingSchemeArray egprs_Header_type3_coding_puncturing_scheme_to_mcs := {
248 MCS_4 /* {0x00, "MCS-4/P1"} */,
249 MCS_4 /* {0x01, "MCS-4/P2"} */,
250 MCS_4 /* {0x02, "MCS-4/P3"} */,
251 MCS_3 /* {0x03, "MCS-3/P1"} */,
252 MCS_3 /* {0x04, "MCS-3/P2"} */,
253 MCS_3 /* {0x05, "MCS-3/P3"} */,
254 MCS_3 /* {0x06, "MCS-3/P1 with padding"} */,
255 MCS_3 /* {0x07, "MCS-3/P2 with padding"} */,
256 MCS_3 /* {0x08, "MCS-3/P3 with padding"} */,
257 MCS_2 /* {0x09, "MCS-2/P1"} */,
258 MCS_2 /* {0x0A, "MCS-2/P2"} */,
259 MCS_1 /* {0x0B, "MCS-1/P1"} */,
260 MCS_1 /* {0x0C, "MCS-1/P2"} */,
261 MCS_2 /* {0x0D, "MCS-2/P1 with padding"} */,
262 MCS_2 /* {0x0E, "MCS-2/P2 with padding"} */,
263 MCS_0 /* {0x0F, "MCS-0"} */
264 };
265 return egprs_Header_type3_coding_puncturing_scheme_to_mcs[cps];
266 }
267
268 function f_rlcmac_cps_htype_to_mcs(uint3_t cps, EgprsHeaderType htype) return CodingScheme {
269 select (htype) {
270 case (RLCMAC_HDR_TYPE_1) { return f_rlcmac_cps_htype1_to_mcs(cps); }
271 case (RLCMAC_HDR_TYPE_2) { return f_rlcmac_cps_htype2_to_mcs(cps); }
272 case (RLCMAC_HDR_TYPE_3) { return f_rlcmac_cps_htype3_to_mcs(cps); }
273 }
274 //TODO: return error here.
275 return CS_1;
276 }
277
278 function f_rlcmac_mcs_to_cps_htype1(CodingScheme mcs, uint2_t part, boolean with_padding) return uint5_t {
279 //TODO: implement similar to f_rlcmac_mcs_to_cps_htype3()
280 //TODO: return error here.
281 return 0;
282 }
283
284 function f_rlcmac_mcs_to_cps_htype2(CodingScheme mcs, uint2_t part, boolean with_padding) return uint5_t {
285 //TODO: implement similar to f_rlcmac_mcs_to_cps_htype3()
286 //TODO: return error here.
287 return 0;
288 }
289
290 function f_rlcmac_mcs_to_cps_htype3(CodingScheme mcs, uint2_t part, boolean with_padding) return uint5_t {
291 select (mcs) {
292 case (MCS_4) {
293 select (part) {
294 case (1) { return 0; /* {0x00, "MCS-4/P1"} */ }
295 case (2) { return 1; /* {0x01, "MCS-4/P2"} */ }
296 case (3) { return 2; /* {0x01, "MCS-4/P2"} */ }
297 }
298 }
299 case (MCS_3) {
300 if (not with_padding) {
301 select (part) {
302 case (1) { return 3; /* {0x03, "MCS-3/P1"} */ }
303 case (2) { return 4; /* {0x04, "MCS-3/P2"} */ }
304 case (3) { return 5; /* {0x05, "MCS-3/P3"} */ }
305 }
306 } else {
307 select (part) {
308 case (1) { return 6; /* {0x06, "MCS-3/P1 with padding"} */ }
309 case (2) { return 7; /* {0x07, "MCS-3/P2 with padding"} */ }
310 case (3) { return 8; /* {0x08, "MCS-3/P3 with padding"} */ }
311 }
312 }
313 }
314 case (MCS_2) {
315 if (not with_padding) {
316 select (part) {
317 case (1) { return 9; /* {0x09, "MCS-2/P1"} */ }
318 case (2) { return 10; /* {0x0A, "MCS-2/P2"} */ }
319 }
320 } else {
321 select (part) {
322 case (1) { return 13; /* {0x0D, "MCS-2/P1 with padding"} */ }
323 case (2) { return 14; /* {0x0E, "MCS-2/P2 with padding"} */}
324 }
325 }
326 }
327 case (MCS_1) {
328 select (part) {
329 case (1) { return 11; /* {0x0B, "MCS-1/P1"} */ }
330 case (2) { return 12; /* {0x0C, "MCS-1/P2"} */ }
331 }
332 }
333 case (MCS_0) { return 15; /* {0x0F, "MCS-0"} */ }
334 }
335 //TODO: return error here.
336 return 0;
337 }
338
339 function f_rlcmac_mcs_to_cps(CodingScheme mcs, uint2_t part, boolean with_padding := false) return uint5_t {
340
341 var EgprsHeaderType htype := f_rlcmac_mcs2headertype(mcs);
342 select (htype) {
343 case (RLCMAC_HDR_TYPE_1) { return f_rlcmac_mcs_to_cps_htype1(mcs, part, with_padding); }
344 case (RLCMAC_HDR_TYPE_2) { return f_rlcmac_mcs_to_cps_htype2(mcs, part, with_padding); }
345 case (RLCMAC_HDR_TYPE_3) { return f_rlcmac_mcs_to_cps_htype3(mcs, part, with_padding); }
346 }
347 //TODO: return error here.
348 return 0;
349 }
350
Vadim Yanitskiyf3cb4dd2020-07-21 01:52:33 +0700351 template (value) RlcmacUlBlock ts_RLC_UL_CTRL_ACK(template (value) RlcmacUlCtrlMsg ctrl,
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200352 MacPayloadType pt := MAC_PT_RLCMAC_NO_OPT,
353 boolean retry := false) := {
354 ctrl := {
355 mac_hdr := {
356 payload_type := pt,
357 spare := '00000'B,
358 retry := retry
359 },
360 payload := ctrl
361 }
362 }
363
364 /* Send Template for Downlink ACK/NACK */
365 template RlcmacUlBlock ts_RLCMAC_DL_ACK_NACK(template uint5_t tfi, AckNackDescription andesc, boolean retry := false) := {
366 ctrl := {
367 mac_hdr := {
368 payload_type := MAC_PT_RLCMAC_NO_OPT,
369 spare := '00000'B,
370 retry := retry
371 },
372 payload := {
373 msg_type := PACKET_DL_ACK_NACK,
374 u := {
375 dl_ack_nack := {
376 dl_tfi := tfi,
377 ack_nack_desc := andesc,
378 chreq_desc_presence := '0'B,
379 chreq_desc := omit,
380 ch_qual_rep := c_ChQualRep_default
381 }
382 }
383 }
384 }
385 }
386
Pau Espin Pedrol6791eb62020-05-20 18:27:10 +0200387 template RlcmacUlBlock ts_RLCMAC_DL_ACK_NACK_CHREQ(template uint5_t tfi,
388 AckNackDescription andesc,
389 boolean retry := false,
390 template ChannelReqDescription chreq_desc := c_ChReqDesc_default)
391 modifies ts_RLCMAC_DL_ACK_NACK := {
392 ctrl := {
393 payload := {
394 u := {
395 dl_ack_nack := {
396 chreq_desc_presence := '1'B,
397 chreq_desc := chreq_desc
398 }
399 }
400 }
401 }
402 }
403
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200404 /* Template for uplink Data block */
Pau Espin Pedrolcb00c522020-11-06 19:52:05 +0100405 template RlcmacUlBlock t_RLCMAC_UL_DATA(template CodingScheme cs, template uint5_t tfi,
406 template uint4_t cv, template uint7_t bsn,
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200407 template LlcBlocks blocks := {}, template boolean stall := false) := {
408 data := {
Pau Espin Pedrolcb00c522020-11-06 19:52:05 +0100409 cs := cs,
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200410 mac_hdr := {
411 payload_type := MAC_PT_RLC_DATA,
412 countdown := cv,
Pau Espin Pedrol80c1baa2020-11-10 17:45:31 +0100413 stall_ind := stall,
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200414 retry := false,
415 spare := '0'B,
416 pfi_ind := false,
417 tfi := tfi,
418 tlli_ind := false,
419 bsn := bsn,
420 e := false
421 },
422 tlli := omit,
423 pfi := omit,
424 blocks := blocks
425 }
426 }
Pau Espin Pedrolcb00c522020-11-06 19:52:05 +0100427 template RlcmacUlBlock t_RLCMAC_UL_DATA_TLLI(template CodingScheme cs, template uint5_t tfi,
428 template uint4_t cv, template uint7_t bsn,
429 template LlcBlocks blocks := {}, template boolean stall := false,
430 template GprsTlli tlli) := {
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200431 data := {
Pau Espin Pedrolcb00c522020-11-06 19:52:05 +0100432 cs := cs,
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200433 mac_hdr := {
434 payload_type := MAC_PT_RLC_DATA,
435 countdown := cv,
Pau Espin Pedrol80c1baa2020-11-10 17:45:31 +0100436 stall_ind := stall,
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200437 retry := false,
438 spare := '0'B,
439 pfi_ind := false,
440 tfi := tfi,
441 tlli_ind := true,
442 bsn := bsn,
443 e := false
444 },
445 tlli := tlli,
446 pfi := omit,
447 blocks := blocks
448 }
449 }
450
Pau Espin Pedrol2456dad2020-04-30 20:22:38 +0200451 /* Template for uplink Data block */
452 template RlcmacUlBlock t_RLCMAC_UL_EGPRS_DATA(CodingScheme mcs,
453 template uint5_t tfi, template uint4_t cv,
Pau Espin Pedrol081b1682020-11-06 17:15:52 +0100454 template uint11_t bsn1, template uint8_t bsn2_offset := 0, template EgprsLlcBlocks blocks := {}) := {
Pau Espin Pedrol2456dad2020-04-30 20:22:38 +0200455 data_egprs := {
Pau Espin Pedrol5abfded2020-11-03 17:30:44 +0100456 mcs := mcs,
Pau Espin Pedrol2456dad2020-04-30 20:22:38 +0200457 mac_hdr := {
458 header_type := f_rlcmac_mcs2headertype(mcs),
459 tfi := tfi,
460 countdown := cv,
461 foi_si := '0'B,
462 r_ri := '0'B,
463 bsn1 := bsn1,
Pau Espin Pedrol081b1682020-11-06 17:15:52 +0100464 bsn2_offset := bsn2_offset,
Pau Espin Pedrol2456dad2020-04-30 20:22:38 +0200465 cps := f_rlcmac_mcs_to_cps(mcs, 1, false),
466 pfi_ind := false,
467 rsb := '0'B,
468 spb := '00'B
469 },
470 tlli_ind := false,
471 e := false,
472 tlli := omit,
473 pfi := omit,
474 blocks := blocks
475 }
476 }
477
Vadim Yanitskiy0a9b1482020-05-10 14:43:21 +0700478 template DlMacHeader t_RLCMAC_DlMacH(template (present) MacPayloadType pt,
479 template (present) boolean rrbp_valid,
480 template (present) MacRrbp rrbp,
481 template (present) uint3_t usf) := {
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200482 payload_type := pt,
483 rrbp := rrbp,
Vadim Yanitskiy0a9b1482020-05-10 14:43:21 +0700484 rrbp_valid := rrbp_valid,
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200485 usf := usf
486 }
487
488 template RlcmacDlBlock tr_RLCMAC_DUMMY_CTRL(template uint3_t usf := ?, template PageMode page_mode := ?) := {
489 ctrl := {
490 mac_hdr := {
491 payload_type := (MAC_PT_RLCMAC_NO_OPT, MAC_PT_RLCMAC_OPT),
492 rrbp:= ?,
493 rrbp_valid := ?,
494 usf := usf
495 },
496 opt := *,
497 payload := {
498 msg_type := PACKET_DL_DUMMY_CTRL,
499 u := {
500 dl_dummy := {
501 page_mode := page_mode,
502 persistence_levels_present := ?,
503 persistence_levels := *
504 }
505 }
506 }
507 }
508 }
509
510 template RlcmacDlBlock tr_RLCMAC_DL_PACKET_ASS(template uint3_t usf := ?) := {
511 ctrl := {
512 mac_hdr := {
513 payload_type := (MAC_PT_RLCMAC_NO_OPT, MAC_PT_RLCMAC_OPT),
514 rrbp:= ?,
515 rrbp_valid := ?,
516 usf := usf
517 },
518 opt := *,
519 payload := {
520 msg_type := PACKET_DL_ASSIGNMENT,
521 u := {
522 dl_assignment := {
523 page_mode := ?,
524 pres1 := ?,
525 persistence_levels := *,
Pau Espin Pedrol984d09f2020-05-19 18:51:58 +0200526 tfi_or_tlli := ?,
527 egprs2 := '0'B,
528 mac_mode := ?,
529 rlc_mode := ?,
530 control_ack := ?,
531 timeslot_alloc := ?,
532 pkt_ta := ?,
533 p0_present := ?,
534 p0 := *,
535 reserved := *,
536 pr_mode := *,
537 freq_par_present := ?,
538 freq_par := *,
539 dl_tfi_ass_present := ?,
540 dl_tfi_assignment := *,
541 pwr_ctrl_present := ?,
542 pwr_ctrl := *,
543 tbf_starting_time_present := ?,
544 tbf_starting_time := *,
Vadim Yanitskiy41b4dd82020-07-22 14:00:56 +0700545 spare := '0'B,
546 rel_additions := *
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200547 }
548 }
549 }
550 }
551 }
552
553 template RlcmacDlBlock tr_RLCMAC_UL_PACKET_ASS(template uint3_t usf := ?) := {
554 ctrl := {
555 mac_hdr := {
556 payload_type := (MAC_PT_RLCMAC_NO_OPT, MAC_PT_RLCMAC_OPT),
557 rrbp:= ?,
558 rrbp_valid := ?,
559 usf := usf
560 },
561 opt := *,
562 payload := {
563 msg_type := PACKET_UL_ASSIGNMENT,
564 u := {
565 ul_assignment := {
566 page_mode := ?,
567 persistence_levels_present := ?,
568 persistence_levels := *,
569 identity := ?,
570 is_egprs := ?, /* msg escape */
Pau Espin Pedrol45b664b2020-05-14 15:16:40 +0200571 gprs := *,
572 egprs := *
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200573 }
574 }
575 }
576 }
577 }
578
Pau Espin Pedrol02c972d2020-05-13 15:56:16 +0200579 template RlcmacDlBlock tr_RLCMAC_UL_PACKET_ASS_GPRS(template uint3_t usf := ?, template PktUlAssGprs gprs := ?)
Vadim Yanitskiyc227ea92020-07-21 02:48:58 +0700580 modifies tr_RLCMAC_UL_PACKET_ASS := {
Pau Espin Pedrol02c972d2020-05-13 15:56:16 +0200581 ctrl := {
582 payload := {
583 u := {
584 ul_assignment := {
585 is_egprs := '0'B,
Pau Espin Pedrol45b664b2020-05-14 15:16:40 +0200586 gprs := gprs,
587 egprs := omit
588 }
589 }
590 }
591 }
592 }
593
594 template RlcmacDlBlock tr_RLCMAC_UL_PACKET_ASS_EGPRS(template uint3_t usf := ?, template PktUlAssEgprs egprs := ?)
Vadim Yanitskiyc227ea92020-07-21 02:48:58 +0700595 modifies tr_RLCMAC_UL_PACKET_ASS := {
Pau Espin Pedrol45b664b2020-05-14 15:16:40 +0200596 ctrl := {
597 payload := {
598 u := {
599 ul_assignment := {
600 is_egprs := '1'B,
601 gprs := omit,
602 egprs := egprs
Pau Espin Pedrol02c972d2020-05-13 15:56:16 +0200603 }
604 }
605 }
606 }
607 }
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200608
609 /* Receive Template for Uplink ACK/NACK */
Pau Espin Pedrol692222c2020-05-17 00:25:37 +0200610 template RlcmacDlBlock tr_RLCMAC_UL_ACK_NACK(template uint5_t ul_tfi) := {
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200611 ctrl := {
612 mac_hdr := {
613 payload_type := (MAC_PT_RLCMAC_NO_OPT, MAC_PT_RLCMAC_OPT),
614 rrbp:= ?,
615 rrbp_valid := ?,
616 usf := ?
617 },
618 opt := *,
619 payload := {
620 msg_type := PACKET_UL_ACK_NACK,
621 u := {
622 ul_ack_nack := {
623 page_mode := ?,
624 msg_excape := ?,
625 uplink_tfi := ul_tfi,
Pau Espin Pedrol692222c2020-05-17 00:25:37 +0200626 is_egprs := ?,
627 gprs := *,
628 egprs := *
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200629 }
630 }
631 }
632 }
Pau Espin Pedrol692222c2020-05-17 00:25:37 +0200633 };
634
635 template RlcmacDlBlock tr_RLCMAC_UL_ACK_NACK_GPRS(template uint5_t ul_tfi, template UlAckNackGprs gprs := tr_UlAckNackGprs(*))
636 modifies tr_RLCMAC_UL_ACK_NACK := {
637 ctrl := {
638 payload := {
639 u := {
640 ul_ack_nack := {
641 is_egprs := '0'B,
642 gprs := gprs,
643 egprs := omit
644 }
645 }
646 }
647 }
648 };
649
650 template RlcmacDlBlock tr_RLCMAC_UL_ACK_NACK_EGPRS(template uint5_t ul_tfi, template UlAckNackEgprs egprs := tr_UlAckNackEgprs(*))
651 modifies tr_RLCMAC_UL_ACK_NACK := {
652 ctrl := {
653 payload := {
654 u := {
655 ul_ack_nack := {
656 is_egprs := '1'B,
657 gprs := omit,
658 egprs := egprs
659 }
660 }
661 }
662 }
663 };
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200664
665 template RlcmacDlBlock tr_RLCMAC_PACKET_PAG_REQ(template uint3_t usf := ?) := {
666 ctrl := {
667 mac_hdr := {
668 payload_type := MAC_PT_RLCMAC_NO_OPT,
669 rrbp:= ?,
670 rrbp_valid := ?,
671 usf := usf
672 },
673 opt := *,
674 payload := {
675 msg_type := PACKET_PAGING_REQUEST,
676 u := {
677 paging := {
678 page_mode := ?,
679 persistence_levels_present := ?,
680 persistence_levels := *,
681 nln_present := ?,
682 nln := *,
Vadim Yanitskiye94164d2020-10-31 05:46:03 +0700683 repeated_pageinfo := *,
684 repeated_pageinfo_term := '0'B
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200685 }
686 }
687 }
688 }
689 }
690
Vadim Yanitskiyb6733a62020-05-10 14:39:00 +0700691 /* Either GPRS or EGPRS data block with arbitrary contents */
692 template RlcmacDlBlock tr_RLCMAC_DATA := (tr_RLCMAC_DATA_GPRS, tr_RLCMAC_DATA_EGPRS);
693
Vadim Yanitskiyd4f22aa2020-05-10 13:13:46 +0700694 template RlcmacDlBlock tr_RLCMAC_DATA_GPRS(template (present) boolean rrbp_valid := ?,
695 template (present) MacRrbp rrbp := ?,
696 template (present) uint3_t usf := ?) := {
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200697 data := {
Pau Espin Pedrol5abfded2020-11-03 17:30:44 +0100698 cs := ?,
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200699 mac_hdr := {
700 mac_hdr := {
701 payload_type := MAC_PT_RLC_DATA,
Vadim Yanitskiyd4f22aa2020-05-10 13:13:46 +0700702 rrbp := rrbp,
703 rrbp_valid := rrbp_valid,
704 usf := usf
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200705 },
706 hdr_ext := ?
707 },
708 blocks := ?
709 }
710 }
711
712 template RlcmacDlBlock tr_RLCMAC_DATA_EGPRS := {
713 data_egprs := {
Pau Espin Pedrol5abfded2020-11-03 17:30:44 +0100714 mcs := ?,
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200715 mac_hdr := ?,
716 fbi := ?,
717 e := ?,
718 blocks := ?
719 }
720 }
721
722 /* Template for Uplink MAC Control Header */
723 template UlMacCtrlHeader t_RLCMAC_UlMacCtrlH(template MacPayloadType pt, template boolean retry := false) := {
724 payload_type := pt,
725 spare := '00000'B,
726 retry := retry
727 }
728
729 /* Template for Uplink Control ACK */
730 template RlcmacUlBlock ts_RLCMAC_CTRL_ACK(GprsTlli tlli, CtrlAck ack := MS_RCVD_TWO_RLC_SAME_RTI_DIFF_RBSN) := {
731 ctrl := {
732 mac_hdr := t_RLCMAC_UlMacCtrlH(MAC_PT_RLCMAC_NO_OPT),
733 payload := {
734 msg_type := PACKET_CONTROL_ACK,
735 u := {
736 ctrl_ack := {
737 tlli := tlli,
738 ctrl_ack := ack
739 }
740 }
741 }
742 }
743 }
744
Pau Espin Pedrol05b6c172020-06-26 17:28:23 +0200745 template LlcBlockHdr t_RLCMAC_LLCBLOCK_HDR(uint16_t length_ind, boolean more, boolean e) := {
746 length_ind := length_ind,
747 more := more, /* 1 = new LLC PDU starts */
748 e := e /* 0 = another extension octet after LLC PDU, 1 = no more extension octets */
749 }
750
751 template EgprsLlcBlockHdr t_RLCMAC_LLCBLOCK_EGPRS_HDR(uint16_t length_ind, boolean e) := {
752 length_ind := length_ind,
753 e := e /* 0 = another extension octet after LLC PDU, 1 = no more extension octets */
754 }
755
756 /* Template for a LlcBlock (part of a LLC frame inside RlcMacDlDataBlock */
757 template LlcBlock t_RLCMAC_LLCBLOCK(octetstring data, template (omit) LlcBlockHdr llc_hdr := omit) := {
758 hdr := llc_hdr, /* omit = let encoder figure out the header */
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200759 payload := data
760 }
761
Pau Espin Pedrol2456dad2020-04-30 20:22:38 +0200762 /* Template for a LlcBlock (part of a LLC frame inside RlcMacEgprs?lDataBlock */
Pau Espin Pedrol05b6c172020-06-26 17:28:23 +0200763 template EgprsLlcBlock t_RLCMAC_LLCBLOCK_EGPRS(octetstring data, template (omit) EgprsLlcBlockHdr llc_hdr := omit) := {
Pau Espin Pedrol2456dad2020-04-30 20:22:38 +0200764 /* let encoder figure out the header */
Pau Espin Pedrol05b6c172020-06-26 17:28:23 +0200765 hdr := llc_hdr, /* omit = let encoder figure out the header */
Pau Espin Pedrol2456dad2020-04-30 20:22:38 +0200766 payload := data
767 }
768
Pau Espin Pedrole8d7d162020-04-29 19:07:36 +0200769} with { encode "RAW"; variant "FIELDORDER(msb)" }