blob: f9697a1ad8bcbc3ccee0cf8d388c3dd3c9596f00 [file] [log] [blame]
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +02001module GPRS_Components {
2/*
3 * Osmocom PCU test suite in TTCN-3, components for GPRS handlng
4 * (C) 2018-2019 Harald Welte <laforge@gnumonks.org>
5 * (C) 2019 Vadim Yanitskiy <axilirator@gmail.com>
6 * (C) 2020 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
7 * All rights reserved.
8 *
9 * Released under the terms of GNU General Public License, Version 2 or
10 * (at your option) any later version.
11 *
12 * SPDX-License-Identifier: GPL-2.0-or-later
13 */
14
15import from General_Types all;
16import from Osmocom_Types all;
17import from GSM_Types all;
18import from GSM_RR_Types all;
19
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +020020import from RLCMAC_CSN1_Types all;
21import from RLCMAC_CSN1_Templates all;
22import from RLCMAC_Types all;
23import from RLCMAC_Templates all;
24
25import from MobileL3_CommonIE_Types all;
26import from L3_Templates all;
27
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +020028import from PCUIF_Types all;
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +020029import from PCUIF_Components all;
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +020030import from Native_Functions all;
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +020031
Pau Espin Pedrol2aead382020-10-29 20:46:47 +010032modulepar {
33 /* ARFCN of 1st TRX. Subsequent TRX are allocated incrementing ARFCNs. Nth TRX => base_arfcn + N-1 */
34 GsmArfcn mp_base_arfcn := 871;
35};
36
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +070037type record TsTrxBtsNum {
38 uint3_t ts_nr,
39 uint3_t trx_nr,
40 uint8_t bts_nr,
41 uint8_t blk_nr
42};
43
Pau Espin Pedrol8155bf42020-10-29 17:34:26 +010044/* Useful to store poll FN + BTS+TRX+TS requested by network */
45type record PollFnCtx {
46 TsTrxBtsNum tstrxbts,
47 uint32_t fn
48};
49
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +070050template (value) TsTrxBtsNum ts_TsTrxBtsNum(uint3_t ts_nr := 7,
51 uint3_t trx_nr := 0,
52 uint8_t bts_nr := 0,
53 uint8_t blk_nr := 0) := {
54 ts_nr := ts_nr,
55 trx_nr := trx_nr,
56 bts_nr := bts_nr,
57 blk_nr := blk_nr
58};
59template TsTrxBtsNum tr_TsTrxBtsNum(template uint3_t ts_nr := ?,
60 template uint3_t trx_nr := ?,
61 template uint8_t bts_nr := ?,
62 template uint8_t blk_nr := ?) := {
63 ts_nr := ts_nr,
64 trx_nr := trx_nr,
65 bts_nr := bts_nr,
66 blk_nr := blk_nr
67};
68
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +020069type union PacketDlAssignChan {
70 PacketDlAssign ccch,
71 PacketDlAssignment pacch
72};
73
74type record DlTbf {
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +010075 GsmRrMessage rr_imm_ass optional,
76 PacketDlAssignChan ass optional,
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +020077 uint5_t tfi,
Pau Espin Pedrol2aead382020-10-29 20:46:47 +010078 GsmArfcn arfcn optional,
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +010079 BIT8 ts_mask,
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +020080 AckNackDescription acknack_desc
81};
82
83type union PacketUlAssignChan {
84 PacketUlAssign ccch,
85 EgprsUlAss ccch_egprs,
86 PacketUlAssignment pacch
87};
88
89type record UlTbf {
Pau Espin Pedroleb980252020-05-18 18:28:17 +020090 GsmRrMessage rr_imm_ass optional,
91 PacketUlAssignChan ass optional,
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +020092 uint5_t tfi,
Pau Espin Pedrol2aead382020-10-29 20:46:47 +010093 GsmArfcn arfcn optional,
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +010094 BIT8 ts_mask,
Pau Espin Pedroleb980252020-05-18 18:28:17 +020095 uint3_t usf[8],
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +020096 boolean is_egprs,
97 uint14_t bsn,
98 CodingScheme tx_cs_mcs
99};
100
101type record GprsMS {
102 hexstring imsi,
103 GprsTlli tlli,
104 uint16_t ra,
105 uint8_t ra_is_11bit,
106 PCUIF_BurstType burst_type,
107 TimingAdvance ta,
108 int16_t lqual_cb,
109 UlTbf ul_tbf optional, /* TODO: Only 1 UL tbf supported for now */
110 DlTbf dl_tbf optional /* TODO: Only 1 DL tbf supported for now */
111};
Vadim Yanitskiycff3e1b2020-10-31 21:12:12 +0700112type record of GprsMS GprsMSList;
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200113
114template AckNackDescription t_AckNackDescription_init := {
115 final_ack := '0'B,
116 starting_seq_nr := 0,
117 receive_block_bitmap := '0000000000000000000000000000000000000000000000000000000000000000'B
118}
119
Pau Espin Pedroleb980252020-05-18 18:28:17 +0200120const uint3_t USF_UNUSED := 7; /* used to indicate PRACH */
121
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200122template (value) GprsMS t_GprsMS_def := {
123 imsi := f_gen_imsi(42),
Pau Espin Pedrolbfd69f62020-10-22 18:06:07 +0200124 tlli := f_gen_tlli(),
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200125 ra := bit2int(chan_req_def),
126 ra_is_11bit := 0,
127 burst_type := BURST_TYPE_0,
128 ta := 0,
129 lqual_cb := 0,
130 ul_tbf := omit,
131 dl_tbf := omit
132};
133
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100134template (value) DlTbf t_DlTbf_def := {
135 rr_imm_ass := omit,
136 ass := omit,
137 tfi := 0,
Pau Espin Pedrol2aead382020-10-29 20:46:47 +0100138 arfcn := omit,
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100139 ts_mask := '00000000'B,
140 acknack_desc := t_AckNackDescription_init
141};
142
Pau Espin Pedroleb980252020-05-18 18:28:17 +0200143template (value) UlTbf t_UlTbf_def := {
144 rr_imm_ass := omit,
145 ass := omit,
146 tfi := 0,
Pau Espin Pedrol2aead382020-10-29 20:46:47 +0100147 arfcn := omit,
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100148 ts_mask := '00000000'B,
Pau Espin Pedroleb980252020-05-18 18:28:17 +0200149 usf := { USF_UNUSED, USF_UNUSED, USF_UNUSED, USF_UNUSED, USF_UNUSED, USF_UNUSED, USF_UNUSED, USF_UNUSED },
150 is_egprs := false,
151 bsn := 0,
152 tx_cs_mcs := CS_1
153};
154
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200155type component MS_BTS_IFACE_CT {
156 /* Virtual BTS component */
157 var RAW_PCU_BTS_CT vc_BTS;
158 /* Connection to the BTS component (one for now) */
159 port RAW_PCU_MSG_PT BTS;
160
Vadim Yanitskiyfa6b8822020-10-31 21:10:29 +0700161 /* Mobile station(s) involved in a testing scenario */
Vadim Yanitskiycff3e1b2020-10-31 21:12:12 +0700162 var GprsMSList g_ms := { };
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200163
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200164 /* Value at which Countdown Procedure starts. Announced by network (GPRS Cell Options as per TS 04.60 Chapter 12.24) */
165 var uint4_t g_bs_cv_max := 4;
166}
167
Vadim Yanitskiy79425802020-10-31 21:23:08 +0700168/* Generate a list of GprsMS (unique IMSI/TLLI, cyclic RA) of the given size */
Vadim Yanitskiyfa6b8822020-10-31 21:10:29 +0700169function f_init_gprs_ms(integer num_ms := 1, template (value) GprsMS t_ms := t_GprsMS_def)
170runs on MS_BTS_IFACE_CT {
Pau Espin Pedrolbfd69f62020-10-22 18:06:07 +0200171 for (var integer i := 0; i < num_ms; i := i + 1 ) {
Vadim Yanitskiyfa6b8822020-10-31 21:10:29 +0700172 var GprsMS ms := valueof(t_ms);
173
Vadim Yanitskiye12b2ac2020-10-31 21:21:47 +0700174 /* We assume that num_ms is not a large number */
175 ms.imsi := f_gen_imsi(i + 1);
176 ms.tlli := int2oct(i + 1, 4);
177
Vadim Yanitskiy79425802020-10-31 21:23:08 +0700178 /* Ensure different RA for siblings */
179 if (ms.ra == bit2int(chan_req_def)) {
180 /* 01111 { 0xx | x0x | xx0 } */
181 f_ms_use_ra(ms, ms.ra + (i mod 7));
182 } else if (ms.ra == bit2int(chan_req_sb)) {
183 /* 01110xxx */
184 f_ms_use_ra(ms, ms.ra + (i mod 8));
185 }
186
Vadim Yanitskiyfa6b8822020-10-31 21:10:29 +0700187 /* Append to the global list */
188 g_ms := g_ms & { ms };
Pau Espin Pedrolbfd69f62020-10-22 18:06:07 +0200189 }
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200190}
191
192
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200193function f_shutdown(charstring file, integer line,
194 boolean final := false)
195runs on MS_BTS_IFACE_CT {
196 /* Determine if the test case was aborted in the middle */
197 if (not final) {
198 log("Test case ", testcasename(), " aborted at ", file, ":", line);
199 } else {
200 /* Guard verdict to avoid 'none' */
201 setverdict(pass);
202 }
203
204 /* Properly shutdown virtual BTS and its clock generator */
205 BTS.send(ts_RAW_PCU_CMD(GENERAL_CMD_SHUTDOWN));
206 vc_BTS.done; /* wait untill it's done */
207
208 /* Shutdown the others and MTC */
209 all component.stop;
210 mtc.stop;
211}
212
Pau Espin Pedrol2aead382020-10-29 20:46:47 +0100213function f_arfcn2trxnr(GsmArfcn arfcn) runs on MS_BTS_IFACE_CT return uint3_t {
214 if (arfcn < mp_base_arfcn) {
215 setverdict(fail, "Unable to find TRX NR for arfcn ", arfcn);
216 f_shutdown(__BFILE__, __LINE__);
217 }
218 return arfcn - mp_base_arfcn;
219}
220
221function f_trxnr2arfcn(uint3_t trx_nr) return GsmArfcn {
222 return mp_base_arfcn + trx_nr;
223}
224
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200225function f_ultbf_new_from_rr_imm_ass(in GsmRrMessage rr_imm_ass)
226runs on MS_BTS_IFACE_CT return UlTbf {
Pau Espin Pedroleb980252020-05-18 18:28:17 +0200227 var UlTbf ul_tbf := valueof(t_UlTbf_def);
228 var uint3_t tn_allocated := rr_imm_ass.payload.imm_ass.pkt_chan_desc.tn;
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200229
230 ul_tbf.rr_imm_ass := rr_imm_ass;
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100231 if (rr_imm_ass.payload.imm_ass.pkt_chan_desc.presence == '0'B and
232 rr_imm_ass.payload.imm_ass.pkt_chan_desc.zero.hopping == '0'B) {
233 ul_tbf.arfcn := rr_imm_ass.payload.imm_ass.pkt_chan_desc.zero.arfcn;
234 }
235 ul_tbf.ts_mask[tn_allocated] := '1'B;
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200236
237 /* Make sure we received an UL TBF Assignment */
238 if (match(rr_imm_ass, tr_IMM_TBF_ASS(dl := false, rest := tr_IaRestOctets_ULAss(?)))) {
239 ul_tbf.ass.ccch := rr_imm_ass.payload.imm_ass.rest_octets.hh.pa.uldl.ass.ul;
240 log("Rx Uplink TBF GPRS assignment: ", ul_tbf.ass.ccch);
241 ul_tbf.is_egprs := false;
242 if (match(ul_tbf.ass.ccch, tr_PacketUlDynAssign)) {
243 ul_tbf.tfi := ul_tbf.ass.ccch.dynamic.tfi_assignment;
Pau Espin Pedrol90401112020-05-20 17:36:27 +0200244 ul_tbf.tx_cs_mcs := f_rlcmac_block_ChCodingCommand2cs_mcs(ul_tbf.ass.ccch.dynamic.ch_coding_cmd);
Pau Espin Pedroleb980252020-05-18 18:28:17 +0200245 ul_tbf.usf[tn_allocated] := ul_tbf.ass.ccch.dynamic.usf;
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200246 } else if (match(ul_tbf.ass.ccch, tr_PacketUlSglAssign)) {
247 /* Nothing to do here yet */
248 }
249 } else if (match(rr_imm_ass, tr_IMM_TBF_ASS(dl := false, rest := tr_IaRestOctets_EGPRSULAss(?)))) {
250 ul_tbf.ass.ccch_egprs := rr_imm_ass.payload.imm_ass.rest_octets.lh.egprs_ul;
251 log("Rx Uplink TBF EGPRS assignment: ", ul_tbf.ass.ccch_egprs);
252 ul_tbf.is_egprs := true;
253 if (match(ul_tbf.ass.ccch_egprs, tr_EgprsUlAssDynamic)) {
254 ul_tbf.tfi := ul_tbf.ass.ccch_egprs.dynamic.tfi_assignment;
Pau Espin Pedrol90401112020-05-20 17:36:27 +0200255 ul_tbf.tx_cs_mcs := f_rlcmac_block_EgprsChCodingCommand2cs_mcs(ul_tbf.ass.ccch_egprs.dynamic.egprs_ch_coding_cmd);
Pau Espin Pedroleb980252020-05-18 18:28:17 +0200256 ul_tbf.usf[tn_allocated] := ul_tbf.ass.ccch_egprs.dynamic.usf;
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200257 } else if (match(ul_tbf.ass.ccch_egprs, tr_EgprsUlAssMultiblock)) {
258 /* Nothing to do here yet */
259 }
260 } else {
261 setverdict(fail, "Failed to match UL TBF Assignment: ", rr_imm_ass);
262 f_shutdown(__BFILE__, __LINE__);
263 }
264
265 setverdict(pass);
266 return ul_tbf;
267}
268
269function f_ultbf_new_from_ass_pacch(RlcmacDlBlock dl_block)
270runs on MS_BTS_IFACE_CT return UlTbf {
Pau Espin Pedroleb980252020-05-18 18:28:17 +0200271 var UlTbf ul_tbf := valueof(t_UlTbf_def);
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100272 var boolean freq_par_present := false;
273 var FrequencyParameters freq_par;
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200274
275 ul_tbf.ass.pacch := dl_block.ctrl.payload.u.ul_assignment;
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200276 ul_tbf.tx_cs_mcs := f_rlcmac_dl_block_get_assigned_ul_cs_mcs(dl_block);
277 ul_tbf.tfi := f_rlcmac_dl_block_get_tfi(dl_block);
278 /* TODO: handle GlobalTfiOrTlli tfi_or_tlli from pkt_ul_ass */
279
280 /* TODO: support single block allocation */
281 if (match(dl_block, tr_RLCMAC_UL_PACKET_ASS_GPRS(?, tr_PktUlAssGprsDynamic(tr_DynamicAllocation(?))))) {
282 ul_tbf.tfi := dl_block.ctrl.payload.u.ul_assignment.gprs.dyn_block_alloc.ul_tfi_assignment;
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100283 freq_par_present := dl_block.ctrl.payload.u.ul_assignment.gprs.freq_par_present == '1'B;
284 if (freq_par_present) {
285 freq_par := dl_block.ctrl.payload.u.ul_assignment.gprs.freq_par;
286 }
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200287 ul_tbf.is_egprs := false;
Pau Espin Pedroleb980252020-05-18 18:28:17 +0200288 for (var integer i := 0; i < 8; i := i + 1) {
289 if (dl_block.ctrl.payload.u.ul_assignment.gprs.dyn_block_alloc.ts_allocation.ts[i].presence == '1'B) {
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100290 ul_tbf.ts_mask[i] := '1'B;
Pau Espin Pedroleb980252020-05-18 18:28:17 +0200291 ul_tbf.usf[i] := dl_block.ctrl.payload.u.ul_assignment.gprs.dyn_block_alloc.ts_allocation.ts[i].usf_tn;
292 }
293 }
294 } else if (match(dl_block, tr_RLCMAC_UL_PACKET_ASS_EGPRS(?, tr_PktUlAssEgprsDynamic(tr_DynamicAllocation(?))))) {
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200295 ul_tbf.tfi := dl_block.ctrl.payload.u.ul_assignment.egprs.dyn_block_alloc.ul_tfi_assignment;
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100296 freq_par_present := dl_block.ctrl.payload.u.ul_assignment.egprs.freq_par_present == '1'B;
297 if (freq_par_present) {
298 freq_par := dl_block.ctrl.payload.u.ul_assignment.egprs.freq_par;
299 }
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200300 ul_tbf.is_egprs := true;
Pau Espin Pedroleb980252020-05-18 18:28:17 +0200301 for (var integer i := 0; i < 8; i := i + 1) {
302 if (dl_block.ctrl.payload.u.ul_assignment.egprs.dyn_block_alloc.ts_allocation.ts[i].presence == '1'B) {
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100303 ul_tbf.ts_mask[i] := '1'B;
Pau Espin Pedroleb980252020-05-18 18:28:17 +0200304 ul_tbf.usf[i] := dl_block.ctrl.payload.u.ul_assignment.egprs.dyn_block_alloc.ts_allocation.ts[i].usf_tn;
305 }
306 }
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200307 }
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100308
309 /* FIXME: freq_par and arfcn are optional. in that case we need to
310 * infer/reuse from current dl_tbf or ul_tbf */
311 if (freq_par_present and freq_par.presence == '00'B) {
312 ul_tbf.arfcn := freq_par.arfcn;
313 }
314
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200315 return ul_tbf;
316}
317
318function f_dltbf_new_from_rr_imm_ass(in GsmRrMessage rr_imm_ass, template PacketDlAssign dl_ass := tr_PacketDlAssign(?))
319runs on MS_BTS_IFACE_CT return DlTbf {
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100320 var DlTbf dl_tbf := valueof(t_DlTbf_def);
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200321
322 dl_tbf.rr_imm_ass := rr_imm_ass;
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100323 if (rr_imm_ass.payload.imm_ass.pkt_chan_desc.presence == '0'B and
324 rr_imm_ass.payload.imm_ass.pkt_chan_desc.zero.hopping == '0'B) {
325 dl_tbf.arfcn := rr_imm_ass.payload.imm_ass.pkt_chan_desc.zero.arfcn;
326 }
327 dl_tbf.ts_mask[rr_imm_ass.payload.imm_ass.pkt_chan_desc.tn] := '1'B;
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200328
329 /* Make sure we received a DL TBF Assignment */
330 if (match(rr_imm_ass, tr_IMM_TBF_ASS(dl := true, rest := tr_IaRestOctets_DLAss(dl_ass)))) {
331 dl_tbf.ass.ccch := rr_imm_ass.payload.imm_ass.rest_octets.hh.pa.uldl.ass.dl;
332 log("Rx Downlink TBF assignment: ", dl_tbf.ass);
333 } else {
334 setverdict(fail, "Failed to match DL TBF Assignment: ", rr_imm_ass);
335 f_shutdown(__BFILE__, __LINE__);
336 }
337
338 /* TODO: match TLLI */
339 if (dl_tbf.ass.ccch.group1_present == '1'B) {
340 dl_tbf.tfi := dl_tbf.ass.ccch.group1.tfi_assignment;
341 } else {
342 setverdict(fail, "Immediate Assignment contains no DL TFI");
343 f_shutdown(__BFILE__, __LINE__);
344 }
345
346 setverdict(pass);
347 return dl_tbf;
348}
349
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200350function f_dltbf_new_from_ass_pacch(RlcmacDlBlock dl_block)
351runs on MS_BTS_IFACE_CT return DlTbf {
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100352 var DlTbf dl_tbf := valueof(t_DlTbf_def);
353 var boolean freq_par_present := false;
354 var FrequencyParameters freq_par;
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200355
356 dl_tbf.ass.pacch := dl_block.ctrl.payload.u.dl_assignment;
357 dl_tbf.tfi := f_rlcmac_dl_block_get_tfi(dl_block);
358 /* TODO: handle GlobalTfiOrTlli tfi_or_tlli from pkt_dl_ass */
Pau Espin Pedrolb20b7e52020-10-28 21:28:45 +0100359
360 if (match(dl_block, tr_RLCMAC_DL_PACKET_ASS(?))) {
361 dl_tbf.tfi := dl_block.ctrl.payload.u.dl_assignment.dl_tfi_assignment;
362 freq_par_present := dl_block.ctrl.payload.u.dl_assignment.freq_par_present == '1'B;
363 if (freq_par_present) {
364 freq_par := dl_block.ctrl.payload.u.dl_assignment.freq_par;
365 }
366 dl_tbf.ts_mask := dl_block.ctrl.payload.u.dl_assignment.timeslot_alloc; /* TODO: is this the correct order ? */
367 /* TODO: check egprs in dl_assignment.rel_additions (PktDlAssR99Additions) */
368 }
369
370 /* FIXME: freq_par and arfcn are optional. in that case we need to
371 * infer/reuse from current dl_tbf or ul_tbf */
372 if (freq_par_present and freq_par.presence == '00'B) {
373 dl_tbf.arfcn := freq_par.arfcn;
374 }
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200375 return dl_tbf;
376}
377
Pau Espin Pedrol2aead382020-10-29 20:46:47 +0100378function f_ms_tx_TsTrxBtsNum(inout GprsMS ms)
379runs on MS_BTS_IFACE_CT return TsTrxBtsNum {
380 var uint3_t ts_nr := f_ultbf_next_ts(ms.ul_tbf);
381
382 var uint3_t trx_nr;
383 if (ispresent(ms.ul_tbf.arfcn)) {
384 trx_nr := f_arfcn2trxnr(ms.ul_tbf.arfcn);
385 } else {
386 /* FIXME: implement search by hsn+maio+ma when freq hopping is enabled */
387 setverdict(fail, "Asked for trx_nr but arfcn not available in ms.ul_tbf!");
388 f_shutdown(__BFILE__, __LINE__);
389 }
390 return valueof(ts_TsTrxBtsNum(ts_nr, trx_nr));
391}
392
393function f_dltbf_num_slots(DlTbf dl_tbf)
394runs on MS_BTS_IFACE_CT return integer {
395 var integer n := 0;
396 for (var integer i := 0; i < lengthof(dl_tbf.ts_mask); i := i + 1) {
397 if (dl_tbf.ts_mask[i] == '1'B) {
398 n := n + 1;
399 }
400 }
401 return n;
402}
403
Pau Espin Pedrol05b6c172020-06-26 17:28:23 +0200404function f_ultbf_inc_bsn(inout UlTbf ul_tbf)
405runs on MS_BTS_IFACE_CT {
406 ul_tbf.bsn := ul_tbf.bsn + 1;
407 ul_tbf.bsn := ul_tbf.bsn mod 128; /* FIXME: EGPRS SNS: 2048 */
408}
409
Pau Espin Pedrol2aead382020-10-29 20:46:47 +0100410function f_ultbf_next_ts(UlTbf ul_tbf)
411runs on MS_BTS_IFACE_CT return uint3_t {
412 /* FIXME: in the future we probably want to store last used internally
413 /* and continue from there */
414 for (var integer i := 0; i < lengthof(ul_tbf.ts_mask); i := i + 1) {
415 if (ul_tbf.ts_mask[i] == '1'B) {
416 return i;
417 }
418 }
419 setverdict(fail, "No TS available for tx!");
420 f_shutdown(__BFILE__, __LINE__);
421 return 0;
422}
423
424function f_ultbf_num_slots(UlTbf ul_tbf)
425runs on MS_BTS_IFACE_CT return integer {
426 var integer n := 0;
427 for (var integer i := 0; i < lengthof(ul_tbf.ts_mask); i := i + 1) {
428 if (ul_tbf.ts_mask[i] == '1'B) {
429 n := n + 1;
430 }
431 }
432 return n;
433}
434
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200435function f_ms_use_ra(inout GprsMS ms, uint16_t ra, uint8_t ra_is_11bit := 0)
436runs on MS_BTS_IFACE_CT {
437 ms.ra_is_11bit := ra_is_11bit;
438 ms.ra := ra;
439 if (ra_is_11bit == 0) {
440 ms.burst_type := BURST_TYPE_0;
441 } else {
442 ms.burst_type := BURST_TYPE_1;
443 }
444}
445
Vadim Yanitskiy7431e9e2020-07-21 01:59:17 +0700446function f_ms_rx_pkt_ass_pacch(inout GprsMS ms, out uint32_t poll_fn,
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700447 template RlcmacDlBlock t_pkt_ass := ?,
448 template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200449runs on MS_BTS_IFACE_CT return RlcmacDlBlock {
450 var RlcmacDlBlock dl_block;
451 var uint32_t dl_fn;
452
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700453 f_rx_rlcmac_dl_block(dl_block, dl_fn, nr := nr);
Vadim Yanitskiy7431e9e2020-07-21 01:59:17 +0700454 if (not match(dl_block, t_pkt_ass)) {
455 setverdict(fail, "Failed to match Packet Assignment:", t_pkt_ass);
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200456 f_shutdown(__BFILE__, __LINE__);
457 }
458
459 poll_fn := f_rrbp_ack_fn(dl_fn, dl_block.ctrl.mac_hdr.rrbp);
460
461 if (match(dl_block, tr_RLCMAC_UL_PACKET_ASS)) {
462 ms.ul_tbf := f_ultbf_new_from_ass_pacch(dl_block);
463 if (ms.ul_tbf.ass.pacch.identity.tlli.tlli != ms.tlli) {
464 setverdict(fail, "Wrong TLLI ", ms.ul_tbf.ass.pacch.identity.tlli, " received vs exp ", ms.tlli);
465 f_shutdown(__BFILE__, __LINE__);
466 }
467 } else if (match(dl_block, tr_RLCMAC_DL_PACKET_ASS)) {
468 ms.dl_tbf := f_dltbf_new_from_ass_pacch(dl_block);
Pau Espin Pedrol25e0f292020-10-29 12:36:40 +0100469 if (ischosen(ms.dl_tbf.ass.pacch.tfi_or_tlli.tlli) and
470 ms.dl_tbf.ass.pacch.tfi_or_tlli.tlli.tlli != ms.tlli) {
471 setverdict(fail, "Wrong TLLI ", ms.dl_tbf.ass.pacch.tfi_or_tlli.tlli.tlli, " received vs exp ", ms.tlli);
472 f_shutdown(__BFILE__, __LINE__);
473 }
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200474 } else {
475 setverdict(fail, "Should not happen:", dl_block);
476 f_shutdown(__BFILE__, __LINE__);
477 }
478
479 return dl_block;
480}
481
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700482function f_ms_establish_ul_tbf(inout GprsMS ms, template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200483runs on MS_BTS_IFACE_CT {
484 var GsmRrMessage rr_imm_ass;
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200485
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700486 rr_imm_ass := f_pcuif_tx_rach_rx_imm_ass(ms.ra, ms.ra_is_11bit, ms.burst_type, ms.ta, nr := nr);
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200487 ms.ul_tbf := f_ultbf_new_from_rr_imm_ass(rr_imm_ass);
488}
489
Vadim Yanitskiy84d1dd52020-05-28 21:09:22 +0700490function f_ms_exp_dl_tbf_ass_ccch(inout GprsMS ms, template PCUIF_Sapi sapi := PCU_IF_SAPI_AGCH,
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700491 template GsmRrMessage t_imm_ass := tr_IMM_TBF_ASS(true, ?, ?),
492 template (present) TsTrxBtsNum nr := tr_TsTrxBtsNum)
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200493runs on MS_BTS_IFACE_CT {
494 var GsmRrMessage rr_imm_ass;
495
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700496 rr_imm_ass := f_pcuif_rx_imm_ass(sapi, t_imm_ass, nr := nr);
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200497 ms.dl_tbf := f_dltbf_new_from_rr_imm_ass(rr_imm_ass, tr_PacketDlAssign(ms.tlli));
498}
499
500/* Enqueue DATA.ind (both TDMA frame and block numbers to be patched) */
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700501function f_ms_tx_data_ind(inout GprsMS ms, octetstring data, uint32_t fn := 0,
502 template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200503runs on MS_BTS_IFACE_CT {
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700504 f_pcuif_tx_data_ind(data, ms.lqual_cb, fn, nr := nr);
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200505}
506
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700507function f_ms_tx_ul_block(inout GprsMS ms, template (value) RlcmacUlBlock ul_data,
508 uint32_t fn := 0, template (omit) CodingScheme force_cs_mcs := omit,
509 template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200510runs on MS_BTS_IFACE_CT return integer {
511 var octetstring data;
512 var integer padding_len;
Pau Espin Pedrol245bfcb2020-06-30 20:17:07 +0200513 var CodingScheme cs_mcs;
514 var uint32_t cs_mcs_len;
515
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200516 /* Encode the payload of DATA.ind */
517 data := enc_RlcmacUlBlock(valueof(ul_data));
Pau Espin Pedrol245bfcb2020-06-30 20:17:07 +0200518
519 if (ispresent(force_cs_mcs)) {
520 cs_mcs := valueof(force_cs_mcs);
521 } else if (ischosen(ul_data.ctrl)) {
522 cs_mcs := CS_1; /* CTRL is always CS1 */
523 } else {
524 /* Add padding to encode payload to minimum required CS/MCS: */
525 cs_mcs := f_rlcmac_block_len_required_cs_mcs(lengthof(data), ischosen(ul_data.data_egprs));
526 }
527
528 cs_mcs_len := f_rlcmac_cs_mcs2block_len(cs_mcs);
529 padding_len := cs_mcs_len - lengthof(data);
530 if (padding_len < 0) {
531 setverdict(fail, "Unable to encode UL block of size ", lengthof(data), " with ", cs_mcs);
532 f_shutdown(__BFILE__, __LINE__);
533 }
534 data := f_pad_oct(data, cs_mcs_len, '00'O);
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200535
536 /* Enqueue DATA.ind (both TDMA frame and block numbers to be patched) */
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700537 f_ms_tx_data_ind(ms, data, fn, nr := nr);
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200538 return padding_len;
539}
540
541/* FIXME: Only supports sending CS-1 so far */
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700542function f_ms_tx_ul_data_block(inout GprsMS ms, octetstring payload,
543 uint4_t cv := 15, boolean with_tlli := false, uint32_t fn := 0,
544 template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200545runs on MS_BTS_IFACE_CT return integer {
546 var template (value) RlcmacUlBlock ul_data;
547 ul_data := t_RLCMAC_UL_DATA(tfi := ms.ul_tbf.tfi,
548 cv := cv,
549 bsn := ms.ul_tbf.bsn,
550 blocks := {t_RLCMAC_LLCBLOCK(payload)});
551 if (with_tlli) {
552 ul_data.data.mac_hdr.tlli_ind := true;
553 ul_data.data.tlli := ms.tlli;
554 }
Pau Espin Pedrol05b6c172020-06-26 17:28:23 +0200555 f_ultbf_inc_bsn(ms.ul_tbf);
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700556 return f_ms_tx_ul_block(ms, ul_data, fn, nr := nr);
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200557}
558
559/* Send random payload for last "num_blocks" blocks in Ul TBF (ending with CV=0). */
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700560function f_ms_tx_ul_data_block_multi(inout GprsMS ms, integer num_blocks := 1, boolean with_tlli := false,
561 template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200562runs on MS_BTS_IFACE_CT return octetstring {
563 var octetstring total_payload := ''O;
564
565 for (var integer i := 0; i < num_blocks; i := i + 1) {
566 var integer padding_len;
567 var octetstring payload := f_rnd_octstring(10);
568 /* Prepare a new UL block (CV, random payload) */
569 var integer cv := num_blocks - i - 1;
570 if (cv > g_bs_cv_max) {
571 cv := 15;
572 }
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700573 padding_len := f_ms_tx_ul_data_block(ms, payload, cv := cv, with_tlli := with_tlli, nr := nr);
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200574 total_payload := total_payload & payload & f_pad_oct(''O, padding_len, '00'O);
575 }
576 return total_payload;
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200577}
578
579function f_rlcmac_dl_block_get_tfi(RlcmacDlBlock dl_block)
580runs on MS_BTS_IFACE_CT return uint5_t {
581 if (ischosen(dl_block.data)) {
582 return dl_block.data.mac_hdr.hdr_ext.tfi;
583 } else if (ischosen(dl_block.data_egprs)) {
584 return dl_block.data_egprs.mac_hdr.tfi;
585 } else { /* Ctrl block */
586 if (match(dl_block, tr_RLCMAC_UL_PACKET_ASS_GPRS(?, tr_PktUlAssGprsDynamic(tr_DynamicAllocation(?))))) {
587 return dl_block.ctrl.payload.u.ul_assignment.gprs.dyn_block_alloc.ul_tfi_assignment;
588 }
589 if (match(dl_block, tr_RLCMAC_UL_PACKET_ASS_EGPRS(?, tr_PktUlAssEgprsDynamic(tr_DynamicAllocation(?))))) {
590 return dl_block.ctrl.payload.u.ul_assignment.egprs.dyn_block_alloc.ul_tfi_assignment;
591 }
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200592 if (match(dl_block, tr_RLCMAC_DL_PACKET_ASS(?))) {
593 return dl_block.ctrl.payload.u.dl_assignment.dl_tfi_assignment;
594 }
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200595 }
596 setverdict(fail, "DlBlock doesn't contain a TFI:", dl_block);
597 f_shutdown(__BFILE__, __LINE__);
598 return 0; /* make compiler happy */
599}
600
601/* Get the Chan coding command from a dl block containing PACCH UL Assignment */
602function f_rlcmac_dl_block_get_assigned_ul_cs_mcs(RlcmacDlBlock dl_block)
603runs on MS_BTS_IFACE_CT return CodingScheme {
604 if (match(dl_block, tr_RLCMAC_UL_PACKET_ASS_GPRS(?, tr_PktUlAssGprsDynamic(?)))) {
605 return f_rlcmac_block_ChCodingCommand2cs_mcs(dl_block.ctrl.payload.u.ul_assignment.gprs.ch_coding_cmd);
606 }
607 if (match(dl_block, tr_RLCMAC_UL_PACKET_ASS_EGPRS(?, tr_PktUlAssEgprsDynamic(?)))) {
608 return f_rlcmac_block_EgprsChCodingCommand2cs_mcs(dl_block.ctrl.payload.u.ul_assignment.egprs.chan_coding_cmd);
609 }
610 setverdict(fail, "DlBlock doesn't contain CS_MCS information:", dl_block);
611 f_shutdown(__BFILE__, __LINE__);
612 return CS_1; /* make compiler happy */
613}
614
615/* TS 44.060 sec 12.3 Ack/Nack Description */
616function f_acknackdesc_ack_block(inout AckNackDescription desc, RlcmacDlBlock dl_block, BIT1 final_ack := '0'B)
617{
618 var uint7_t bsn;
619 var integer i;
620 var integer inc;
621
622 if (ischosen(dl_block.data)) {
623 bsn := dl_block.data.mac_hdr.hdr_ext.bsn;
624 } else {
625 bsn := dl_block.data_egprs.mac_hdr.bsn1;
626 }
627
628 inc := bsn - desc.starting_seq_nr + 1;
629 /* Filling hole? */
630 if (bsn < desc.starting_seq_nr) {
631 desc.receive_block_bitmap[lengthof(desc.receive_block_bitmap) - (desc.starting_seq_nr - bsn)] := int2bit(1, 1);
632 return;
633 }
634
635 /* SSN is increased, and so RBB values need to be moved */
636 for (i := 0; i < lengthof(desc.receive_block_bitmap) - inc; i := i+1) {
637 desc.receive_block_bitmap[i] := desc.receive_block_bitmap[i + inc];
638 }
639 for (i := lengthof(desc.receive_block_bitmap) - inc; i < lengthof(desc.receive_block_bitmap) - 1; i := i+1) {
640 desc.receive_block_bitmap[i] := int2bit(0, 1);
641 }
642 /* Now we can set current bit and update SSN */
643 desc.starting_seq_nr := bsn + 1;
644 desc.receive_block_bitmap[lengthof(desc.receive_block_bitmap) - 1] := int2bit(1, 1);
645
646 /* Finally update the final_ack bit as requested: */
647 desc.final_ack := final_ack;
648}
649
650/* This function can be used to send DATA.cnf in response to the IUT originated DATA.req.
651 * NOTE: it's the responsibility of caller to make sure that pcu_msg contains u.data_req. */
652function f_pcuif_tx_data_cnf(in PCUIF_Message pcu_msg)
653runs on MS_BTS_IFACE_CT {
654 var PCUIF_Message pcu_msg_cnf := {
655 msg_type := PCU_IF_MSG_DATA_CNF,
656 bts_nr := pcu_msg.bts_nr,
657 spare := pcu_msg.spare,
658 u := { data_cnf := pcu_msg.u.data_req }
659 };
660
661 /* PCU wants DATA.cnf containing basically everything that was in DATA.req,
662 * but PCU_IF_SAPI_PCH is a special case - paging group shall be excluded. */
663 if (pcu_msg.u.data_req.sapi == PCU_IF_SAPI_PCH) {
664 pcu_msg_cnf.u.data_cnf.data := substr(pcu_msg.u.data_req.data, 3,
665 pcu_msg.u.data_req.len - 3);
666 }
667
668 BTS.send(pcu_msg_cnf);
669}
670
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200671////////////////////////
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700672// Low level APIs
Pau Espin Pedrol4f7b8fd2020-05-18 18:28:17 +0200673////////////////////////
674
Vadim Yanitskiy7466c332020-05-28 20:41:19 +0700675function f_pcuif_rx_imm_ass(template PCUIF_Sapi sapi := PCU_IF_SAPI_AGCH,
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700676 template GsmRrMessage t_imm_ass := ?,
677 template (present) TsTrxBtsNum nr := tr_TsTrxBtsNum)
Vadim Yanitskiy7466c332020-05-28 20:41:19 +0700678runs on MS_BTS_IFACE_CT return GsmRrMessage {
679 var GsmRrMessage rr_imm_ass;
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200680 var PCUIF_Message pcu_msg;
681 var octetstring data;
682 timer T;
683
684 T.start(2.0);
685 alt {
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700686 [] BTS.receive(tr_PCUIF_DATA_REQ(nr.bts_nr, nr.trx_nr, ts_nr := 0,
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200687 sapi := sapi, data := ?)) -> value pcu_msg {
688 /* On PCH the payload is prefixed with paging group (3 octets): skip it.
689 * TODO: add an additional template parameter, so we can match it. */
690 if (pcu_msg.u.data_req.sapi == PCU_IF_SAPI_PCH) {
691 data := substr(pcu_msg.u.data_req.data, 3, pcu_msg.u.data_req.len - 3);
692 } else {
693 data := pcu_msg.u.data_req.data;
694 }
695
696 rr_imm_ass := dec_GsmRrMessage(data);
697 if (not match(rr_imm_ass, t_imm_ass)) {
698 /* Not for us? Wait for more. */
699 repeat;
700 }
701
702 log("Rx Immediate Assignment: ", rr_imm_ass);
Pau Espin Pedrol34c940b2020-05-28 19:56:11 +0700703
704 /* Send DATA.cnf back to the IUT (only needed for PCH) */
705 if (pcu_msg.u.data_req.sapi == PCU_IF_SAPI_PCH) {
706 f_pcuif_tx_data_cnf(pcu_msg);
707 }
708
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200709 setverdict(pass);
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200710 }
711 [] BTS.receive { repeat; }
712 [] T.timeout {
713 setverdict(fail, "Timeout waiting for Immediate Assignment");
Pau Espin Pedrolfddc20b2020-05-28 19:50:29 +0700714 f_shutdown(__BFILE__, __LINE__);
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200715 }
716 }
717
Vadim Yanitskiy7466c332020-05-28 20:41:19 +0700718 return rr_imm_ass;
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200719}
720
721/* One phase packet access (see 3GPP TS 44.018, table 9.1.8.1) */
Vadim Yanitskiy1cea9fd2020-10-31 21:34:05 +0700722const BIT8 chan_req_def := '01111000'B; /* 01111 { 0xx | x0x | xx0 } */
723/* Single block (two phase or RR signalling) packet access */
724const BIT8 chan_req_sb := '01110000'B; /* 01110xxx */
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200725
726/* Establish an Uplink TBF by sending RACH.ind towards the PCU */
Vadim Yanitskiy28d18e12020-05-29 15:25:59 +0700727function f_pcuif_tx_rach_rx_imm_ass(uint16_t ra := bit2int(chan_req_def),
728 uint8_t is_11bit := 0,
729 PCUIF_BurstType burst_type := BURST_TYPE_0,
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700730 TimingAdvance ta := 0,
731 template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Vadim Yanitskiy7466c332020-05-28 20:41:19 +0700732runs on MS_BTS_IFACE_CT return GsmRrMessage {
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200733 var uint32_t fn;
734
735 /* FIXME: ask the BTS component to give us the current TDMA fn */
736 fn := 1337 + ta;
737
738 /* Send RACH.ind */
739 log("Sending RACH.ind on fn=", fn, " with RA=", ra, ", TA=", ta);
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700740 BTS.send(ts_PCUIF_RACH_IND(nr.bts_nr, nr.trx_nr, ts_nr := 0,
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200741 ra := ra, is_11bit := is_11bit,
742 burst_type := burst_type,
Pau Espin Pedrol2aead382020-10-29 20:46:47 +0100743 fn := fn, arfcn := f_trxnr2arfcn(valueof(nr.trx_nr)),
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200744 qta := ta * 4));
745
746 /* 3GPP TS 44.018, table 9.1.8.1, note 2b: Request Reference shall be set to 127
747 * when Immediate Assignment is triggered by EGPRS Packet Channel Request. Here
748 * we assume that 11 bit RA always contains EGPRS Packet Channel Request. */
749 if (is_11bit != 0) { ra := 127; }
750
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700751 /* Expect Immediate (TBF) Assignment on the same TS/TRX/BTS */
752 return f_pcuif_rx_imm_ass(PCU_IF_SAPI_AGCH, tr_IMM_TBF_ASS(false, ra, fn), nr);
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200753}
754
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200755/* Enqueue DATA.ind (both TDMA frame and block numbers to be patched) */
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700756function f_pcuif_tx_data_ind(octetstring data, int16_t lqual_cb := 0, uint32_t fn := 0,
757 template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200758runs on MS_BTS_IFACE_CT {
759 var template RAW_PCU_EventParam ev_param := {tdma_fn := ? };
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700760 BTS.send(ts_PCUIF_DATA_IND(nr.bts_nr, nr.trx_nr, nr.ts_nr, nr.blk_nr,
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200761 sapi := PCU_IF_SAPI_PDTCH, data := data,
Pau Espin Pedrol2aead382020-10-29 20:46:47 +0100762 fn := fn, arfcn := f_trxnr2arfcn(valueof(nr.trx_nr)),
763 lqual_cb := lqual_cb));
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200764 if (fn != 0) {
765 ev_param := {tdma_fn := fn };
766 }
767 BTS.receive(tr_RAW_PCU_EV(TDMA_EV_PDTCH_BLOCK_SENT, ev_param));
768}
769
770/* Enqueue RTS.req, expect DATA.req with UL ACK from the PCU */
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700771function f_pcuif_rx_data_req(out PCUIF_Message pcu_msg,
772 template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200773runs on MS_BTS_IFACE_CT {
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700774 BTS.send(ts_PCUIF_RTS_REQ(nr.bts_nr, nr.trx_nr, nr.ts_nr,
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200775 sapi := PCU_IF_SAPI_PDTCH, fn := 0,
Pau Espin Pedrol2aead382020-10-29 20:46:47 +0100776 arfcn := f_trxnr2arfcn(valueof(nr.trx_nr)), block_nr := nr.blk_nr));
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700777 BTS.receive(tr_PCUIF_DATA_REQ(nr.bts_nr, nr.trx_nr, nr.ts_nr,
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200778 sapi := PCU_IF_SAPI_PDTCH)) -> value pcu_msg;
779}
780
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200781/* Expect a Paging Request Type 1 from PCU on PCUIF on specified sapi. */
782function f_pcuif_rx_pch_pag_req1(template MobileIdentityV mi1 := ?,
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700783 template integer pag_group := ?,
784 template (present) TsTrxBtsNum nr := tr_TsTrxBtsNum)
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200785runs on MS_BTS_IFACE_CT return GsmRrMessage {
786 var GsmRrMessage rr_pag_req1;
787 var PCUIF_Message pcu_msg;
788 var octetstring imsi_suff_octstr;
789 var integer pag_group_rx;
790 var octetstring macblock;
791
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700792 BTS.receive(tr_PCUIF_DATA_REQ(nr.bts_nr, nr.trx_nr, nr.ts_nr,
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200793 sapi := PCU_IF_SAPI_PCH)) -> value pcu_msg;
794
795 /* First 3 bytes contain IMSI suffix to calculate paging group: */
796 imsi_suff_octstr := substr(pcu_msg.u.data_req.data, 0, 3);
797 pag_group_rx := str2int(oct2char(imsi_suff_octstr[0])) * 100 +
798 str2int(oct2char(imsi_suff_octstr[1])) * 10 +
799 str2int(oct2char(imsi_suff_octstr[2]));
800
801 /* Make sure we've got RR Paging Request Type 1 for a given MI */
802 macblock := substr(pcu_msg.u.data_req.data, 3, pcu_msg.u.data_req.len - 3);
803 rr_pag_req1 := dec_GsmRrMessage(macblock);
804 if (not match(rr_pag_req1, tr_PAG_REQ1(tr_MI_LV(mi1)))) {
805 setverdict(fail, "Failed to match Paging Request Type 1: ", rr_pag_req1);
806 f_shutdown(__BFILE__, __LINE__);
807 }
808
809 /* Make sure that received paging froup matches the expected one */
810 if (not match(pag_group_rx, pag_group)) {
811 setverdict(fail, "Paging group", pag_group_rx, " does not match expected ", pag_group);
812 f_shutdown(__BFILE__, __LINE__);
813 }
814
815 f_pcuif_tx_data_cnf(pcu_msg);
816 return rr_pag_req1;
817}
818
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700819function f_rx_rlcmac_dl_block(out RlcmacDlBlock dl_block, out uint32_t dl_fn,
820 template (present) CodingScheme exp_cs_mcs := ?,
821 template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200822runs on MS_BTS_IFACE_CT {
823 var PCUIF_Message pcu_msg;
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700824 f_pcuif_rx_data_req(pcu_msg, nr := nr);
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200825 dl_block := dec_RlcmacDlBlock(pcu_msg.u.data_req.data);
826 dl_fn := pcu_msg.u.data_req.fn;
827
828 var integer len := lengthof(pcu_msg.u.data_req.data);
829 var CodingScheme cs_mcs := f_rlcmac_block_len2cs_mcs(len)
830 if (not match(f_rlcmac_block_len2cs_mcs(len), exp_cs_mcs)) {
831 setverdict(fail, "Failed to match Coding Scheme exp ", exp_cs_mcs, " vs ", cs_mcs, " (", len, ")");
832 f_shutdown(__BFILE__, __LINE__);
833 }
834}
835
Pau Espin Pedrolcdbe9032020-07-07 20:20:42 +0200836function f_rx_rlcmac_dl_block_exp_ack_nack(out RlcmacDlBlock dl_block, out uint32_t poll_fn,
837 template RlcmacDlBlock acknack_tmpl := (tr_RLCMAC_UL_ACK_NACK_GPRS(ul_tfi := ?),
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700838 tr_RLCMAC_UL_ACK_NACK_EGPRS(ul_tfi := ?)),
839 template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200840runs on MS_BTS_IFACE_CT {
841 var uint32_t dl_fn;
842
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700843 f_rx_rlcmac_dl_block(dl_block, dl_fn, nr := nr);
Pau Espin Pedrolcdbe9032020-07-07 20:20:42 +0200844 if (match(dl_block, acknack_tmpl)) {
Pau Espin Pedrol692222c2020-05-17 00:25:37 +0200845 poll_fn := f_rrbp_ack_fn(dl_fn, dl_block.ctrl.mac_hdr.rrbp);
846 return;
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200847 }
Pau Espin Pedrol692222c2020-05-17 00:25:37 +0200848 setverdict(fail, "Failed to match Packet Uplink ACK / NACK:", dl_block);
849 f_shutdown(__BFILE__, __LINE__);
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200850}
851
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700852function f_rx_rlcmac_dl_block_exp_dummy(out RlcmacDlBlock dl_block,
853 template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200854runs on MS_BTS_IFACE_CT {
855 var uint32_t dl_fn;
856
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700857 f_rx_rlcmac_dl_block(dl_block, dl_fn, nr := nr);
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200858 if (not match(dl_block, tr_RLCMAC_DUMMY_CTRL())) {
859 setverdict(fail, "Failed to match Packet DUMMY DL");
860 f_shutdown(__BFILE__, __LINE__);
861 }
862}
863
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700864function f_rx_rlcmac_dl_block_exp_pkt_pag_req(out RlcmacDlBlock dl_block,
865 template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200866runs on MS_BTS_IFACE_CT {
867 var uint32_t dl_fn;
868
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700869 f_rx_rlcmac_dl_block(dl_block, dl_fn, nr := nr);
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200870 if (not match(dl_block, tr_RLCMAC_PACKET_PAG_REQ())) {
871 setverdict(fail, "Failed to match Packet Paging Request: ", dl_block, " vs ", tr_RLCMAC_PACKET_PAG_REQ());
872 f_shutdown(__BFILE__, __LINE__);
873 }
874}
875
876/* This function does what could probably be done with templates */
877function f_rlcmac_dl_block_verify_data_gprs(in RlcmacDlDataBlock data_block,
878 template (present) octetstring data := ?,
879 template (present) uint7_t exp_bsn := ?,
880 template (present) CodingScheme exp_cs := ?)
881runs on MS_BTS_IFACE_CT {
882 if (not match(data_block.mac_hdr.hdr_ext.bsn, exp_bsn)) {
883 setverdict(fail, "DL block BSN doesn't match: ",
884 data_block.mac_hdr.hdr_ext.bsn, " vs exp ", exp_bsn);
885 }
886
887 if (lengthof(data_block.blocks) < 1) {
888 setverdict(fail, "DL block has no LLC payload: ", data_block);
889 f_shutdown(__BFILE__, __LINE__);
890 }
891
892 if (not match(data_block.blocks[0].payload, data)) {
893 setverdict(fail, "Failed to match content of LLC payload in DL Block: ",
894 data_block.blocks[0].payload, " vs ", data);
895 f_shutdown(__BFILE__, __LINE__);
896 }
897
898 /* Check next data blocks contain dummy frames */
899 if (lengthof(data_block.blocks) > 1 and substr(data_block.blocks[1].payload, 0, 3) != '43C001'O) {
900 setverdict(fail, "Second data payload is not a dummy frame: ",
901 data_block.blocks[1].payload);
902 f_shutdown(__BFILE__, __LINE__);
903 }
904
905 /* TODO: check exp_cs */
906}
907
908/* This function does what could probably be done with templates */
909function f_rlcmac_dl_block_verify_data_egprs(in RlcmacDlEgprsDataBlock data_block,
910 template (present) octetstring data := ?,
911 template (present) uint14_t exp_bsn := ?,
912 template (present) CodingScheme exp_cs := ?)
913runs on MS_BTS_IFACE_CT {
914 if (not match(data_block.mac_hdr.bsn1, exp_bsn)) {
915 setverdict(fail, "DL block BSN doesn't match: ",
916 data_block.mac_hdr.bsn1, " vs exp ", exp_bsn);
917 }
918
919 if (lengthof(data_block.blocks) < 1) {
920 setverdict(fail, "DL block has no LLC payload: ", data_block);
921 f_shutdown(__BFILE__, __LINE__);
922 }
923
924 if (not match(data_block.blocks[0].payload, data)) {
925 setverdict(fail, "Failed to match content of LLC payload in DL Block: ",
926 data_block.blocks[0].payload, " vs ", data);
927 f_shutdown(__BFILE__, __LINE__);
928 }
929
930 /* Check next data blocks contain dummy frames */
931 if (lengthof(data_block.blocks) > 1 and substr(data_block.blocks[1].payload, 0, 3) != '43C001'O) {
932 setverdict(fail, "Second data payload is not a dummy frame: ",
933 data_block.blocks[1].payload);
934 f_shutdown(__BFILE__, __LINE__);
935 }
936
937 /* TODO: Check exp_cs. In the case of EGPRS, first check mac_hdr.header_type and then decode CPS = exp_cs based on mac_hdr.header_type.
938 See wireshark's egprs_Header_type1_coding_puncturing_scheme_to_mcs. */
939}
940
941/* High level (task specific) helper for receiving and matching GPRS/EGPRS data blocks */
942function f_rx_rlcmac_dl_block_exp_data(out RlcmacDlBlock dl_block, out uint32_t dl_fn,
943 template (present) octetstring data := ?,
944 template (present) uint7_t exp_bsn := ?,
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700945 template (present) CodingScheme exp_cs := ?,
946 template (value) TsTrxBtsNum nr := ts_TsTrxBtsNum)
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200947runs on MS_BTS_IFACE_CT {
948 /* FIXME: ideally we should use an alt statement with timeout here, rather than
949 * having +100500 layers of abstraction. This would facilitate developing the
950 * multi-TBF/-TRX/-BTS tests, where you cannot expect that the first received
951 * block is exactly what you need. */
Vadim Yanitskiy4b7473d2020-09-21 04:15:39 +0700952 f_rx_rlcmac_dl_block(dl_block, dl_fn, nr := nr);
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +0200953
954 /* Make sure it's either GPRS or EGPRS data block */
955 if (not match(dl_block, tr_RLCMAC_DATA)) {
956 setverdict(fail, "Failed to match DL DATA: ", dl_block, " vs ", tr_RLCMAC_DATA);
957 f_shutdown(__BFILE__, __LINE__);
958 }
959
960 if (ischosen(dl_block.data_egprs)) {
961 f_rlcmac_dl_block_verify_data_egprs(dl_block.data_egprs, data, exp_bsn, exp_cs);
962 } else if (ischosen(dl_block.data)) {
963 f_rlcmac_dl_block_verify_data_gprs(dl_block.data, data, exp_bsn, exp_cs);
964 } else {
965 /* Should not happen, but the caller may theoretically give us a template for CTRL */
966 setverdict(fail, "DL block is neither GPRS nor EGPRS data block: ", dl_block);
967 f_shutdown(__BFILE__, __LINE__);
968 }
969}
970
971function f_dl_block_ack_fn(in RlcmacDlBlock dl_block, uint32_t dl_fn)
972runs on MS_BTS_IFACE_CT return uint32_t {
973 var boolean rrbp_valid;
974 var MacRrbp rrbp;
975
976 /* The argument must be either a GPRS or EGPRS data block */
977 if (ischosen(dl_block.data_egprs)) {
978 rrbp_valid := true; /* always valid */
979 rrbp := dl_block.data_egprs.mac_hdr.rrbp;
980 } else if (ischosen(dl_block.data)) {
981 rrbp_valid := dl_block.data.mac_hdr.mac_hdr.rrbp_valid;
982 rrbp := dl_block.data.mac_hdr.mac_hdr.rrbp;
983 } else {
984 rrbp_valid := dl_block.ctrl.mac_hdr.rrbp_valid;
985 rrbp := dl_block.ctrl.mac_hdr.rrbp;
986 }
987
988 /* Make sure that the given block really needs to be ACKnowledged */
989 if (not rrbp_valid) {
990 setverdict(fail, "DL block shall not be ACKnowledged, field RRBP is not valid");
991 f_shutdown(__BFILE__, __LINE__);
992 }
993
994 return f_rrbp_ack_fn(dl_fn, rrbp);
995}
996
Vadim Yanitskiy3e5f0742020-11-01 03:30:18 +0700997/* Return true if a given Packet Paging Request contains the given IMSI, false otherwise */
998function f_pkt_paging_match_imsi(in PacketPagingReq req, template hexstring imsi,
999 boolean cs_domain := true, boolean ps_domain := true)
1000runs on MS_BTS_IFACE_CT return boolean {
Vadim Yanitskiye94164d2020-10-31 05:46:03 +07001001 if (not ispresent(req.repeated_pageinfo)) {
1002 setverdict(fail, "Packet Paging Request without MIs?!?");
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +02001003 f_shutdown(__BFILE__, __LINE__);
1004 }
Vadim Yanitskiye94164d2020-10-31 05:46:03 +07001005
1006 for (var integer i := 0; i < lengthof(req.repeated_pageinfo); i := i + 1) {
1007 var PageInfo info := req.repeated_pageinfo[i].item;
Vadim Yanitskiy3e5f0742020-11-01 03:30:18 +07001008 var MobileIdentityLV_Paging mi_lv;
Vadim Yanitskiye94164d2020-10-31 05:46:03 +07001009
Vadim Yanitskiy3e5f0742020-11-01 03:30:18 +07001010 if (ischosen(info.cs)) { /* CS domain */
1011 if (not ispresent(info.cs.mobile_identity))
1012 { continue; }
1013 if (not cs_domain)
1014 { continue; }
1015 mi_lv := info.cs.mobile_identity;
1016 } else { /* PS domain */
1017 if (not ispresent(info.ps.mobile_identity))
1018 { continue; }
1019 if (not ps_domain)
1020 { continue; }
1021 mi_lv := info.ps.mobile_identity;
1022 }
1023
1024 /* Make sure MI contains IMSI before referencing it */
1025 if (match(mi_lv.mobile_id, decmatch tr_MI_IMSI(imsi))) {
1026 return true;
Vadim Yanitskiye94164d2020-10-31 05:46:03 +07001027 }
1028 }
1029
Vadim Yanitskiy3e5f0742020-11-01 03:30:18 +07001030 return false;
1031}
1032
1033/* Return true if a given Packet Paging Request contains the given P-TMSI, false otherwise */
1034function f_pkt_paging_match_tmsi(in PacketPagingReq req, template GsmTmsi tmsi,
1035 boolean cs_domain := true, boolean ps_domain := true)
1036runs on MS_BTS_IFACE_CT return boolean {
1037 if (not ispresent(req.repeated_pageinfo)) {
1038 setverdict(fail, "Packet Paging Request without MIs?!?");
1039 f_shutdown(__BFILE__, __LINE__);
1040 }
1041
1042 for (var integer i := 0; i < lengthof(req.repeated_pageinfo); i := i + 1) {
1043 var PageInfo info := req.repeated_pageinfo[i].item;
1044
1045 if (cs_domain and ischosen(info.cs)) {
1046 if (not ispresent(info.cs.tmsi))
1047 { continue; }
1048 if (match(info.cs.tmsi, tmsi))
1049 { return true; }
1050 } else if (ps_domain) {
1051 if (not ispresent(info.ps.ptmsi))
1052 { continue; }
1053 if (match(info.ps.ptmsi, tmsi))
1054 { return true; }
1055 }
1056 }
1057
1058 return false;
Pau Espin Pedrolaedc5112020-05-16 17:30:42 +02001059}
1060
1061}