Pau Espin Pedrol | aedc511 | 2020-05-16 17:30:42 +0200 | [diff] [blame] | 1 | module 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 | |
| 15 | import from General_Types all; |
| 16 | import from Osmocom_Types all; |
| 17 | import from GSM_Types all; |
| 18 | import from GSM_RR_Types all; |
| 19 | |
| 20 | import from Osmocom_VTY_Functions all; |
| 21 | import from TELNETasp_PortType all; |
| 22 | |
| 23 | import from MobileL3_GMM_SM_Types all; |
| 24 | import from RLCMAC_CSN1_Types all; |
| 25 | import from RLCMAC_CSN1_Templates all; |
| 26 | import from RLCMAC_Types all; |
| 27 | import from RLCMAC_Templates all; |
| 28 | |
| 29 | import from MobileL3_CommonIE_Types all; |
| 30 | import from L3_Templates all; |
| 31 | |
| 32 | import from NS_Types all; |
| 33 | import from BSSGP_Types all; |
| 34 | import from Osmocom_Gb_Types all; |
| 35 | |
| 36 | import from BSSGP_Emulation all; /* BssgpConfig */ |
| 37 | import from NS_Emulation all; /* NSConfiguration */ |
| 38 | |
| 39 | import from UD_Types all; |
| 40 | import from PCUIF_Types all; |
| 41 | import from PCUIF_CodecPort all; |
| 42 | import from PCUIF_Components all; |
| 43 | import from IPL4asp_Types all; |
| 44 | import from Native_Functions all; |
| 45 | import from SGSN_Components all; |
| 46 | |
| 47 | type component MS_BTS_IFACE_CT { |
| 48 | /* Virtual BTS component */ |
| 49 | var RAW_PCU_BTS_CT vc_BTS; |
| 50 | /* Connection to the BTS component (one for now) */ |
| 51 | port RAW_PCU_MSG_PT BTS; |
| 52 | |
| 53 | /* Value at which Countdown Procedure starts. Announced by network (GPRS Cell Options as per TS 04.60 Chapter 12.24) */ |
| 54 | var uint4_t g_bs_cv_max := 4; |
| 55 | } |
| 56 | |
| 57 | function f_shutdown(charstring file, integer line, |
| 58 | boolean final := false) |
| 59 | runs on MS_BTS_IFACE_CT { |
| 60 | /* Determine if the test case was aborted in the middle */ |
| 61 | if (not final) { |
| 62 | log("Test case ", testcasename(), " aborted at ", file, ":", line); |
| 63 | } else { |
| 64 | /* Guard verdict to avoid 'none' */ |
| 65 | setverdict(pass); |
| 66 | } |
| 67 | |
| 68 | /* Properly shutdown virtual BTS and its clock generator */ |
| 69 | BTS.send(ts_RAW_PCU_CMD(GENERAL_CMD_SHUTDOWN)); |
| 70 | vc_BTS.done; /* wait untill it's done */ |
| 71 | |
| 72 | /* Shutdown the others and MTC */ |
| 73 | all component.stop; |
| 74 | mtc.stop; |
| 75 | } |
| 76 | |
| 77 | template AckNackDescription t_AckNackDescription_init := { |
| 78 | final_ack := '0'B, |
| 79 | starting_seq_nr := 0, |
| 80 | receive_block_bitmap := '0000000000000000000000000000000000000000000000000000000000000000'B |
| 81 | } |
| 82 | |
| 83 | function f_rlcmac_dl_block_get_tfi(RlcmacDlBlock dl_block) |
| 84 | runs on MS_BTS_IFACE_CT return uint5_t { |
| 85 | if (ischosen(dl_block.data)) { |
| 86 | return dl_block.data.mac_hdr.hdr_ext.tfi; |
| 87 | } else if (ischosen(dl_block.data_egprs)) { |
| 88 | return dl_block.data_egprs.mac_hdr.tfi; |
| 89 | } else { /* Ctrl block */ |
| 90 | if (match(dl_block, tr_RLCMAC_UL_PACKET_ASS_GPRS(?, tr_PktUlAssGprsDynamic(tr_DynamicAllocation(?))))) { |
| 91 | return dl_block.ctrl.payload.u.ul_assignment.gprs.dyn_block_alloc.ul_tfi_assignment; |
| 92 | } |
| 93 | if (match(dl_block, tr_RLCMAC_UL_PACKET_ASS_EGPRS(?, tr_PktUlAssEgprsDynamic(tr_DynamicAllocation(?))))) { |
| 94 | return dl_block.ctrl.payload.u.ul_assignment.egprs.dyn_block_alloc.ul_tfi_assignment; |
| 95 | } |
| 96 | } |
| 97 | setverdict(fail, "DlBlock doesn't contain a TFI:", dl_block); |
| 98 | f_shutdown(__BFILE__, __LINE__); |
| 99 | return 0; /* make compiler happy */ |
| 100 | } |
| 101 | |
| 102 | /* Get the Chan coding command from a dl block containing PACCH UL Assignment */ |
| 103 | function f_rlcmac_dl_block_get_assigned_ul_cs_mcs(RlcmacDlBlock dl_block) |
| 104 | runs on MS_BTS_IFACE_CT return CodingScheme { |
| 105 | if (match(dl_block, tr_RLCMAC_UL_PACKET_ASS_GPRS(?, tr_PktUlAssGprsDynamic(?)))) { |
| 106 | return f_rlcmac_block_ChCodingCommand2cs_mcs(dl_block.ctrl.payload.u.ul_assignment.gprs.ch_coding_cmd); |
| 107 | } |
| 108 | if (match(dl_block, tr_RLCMAC_UL_PACKET_ASS_EGPRS(?, tr_PktUlAssEgprsDynamic(?)))) { |
| 109 | return f_rlcmac_block_EgprsChCodingCommand2cs_mcs(dl_block.ctrl.payload.u.ul_assignment.egprs.chan_coding_cmd); |
| 110 | } |
| 111 | setverdict(fail, "DlBlock doesn't contain CS_MCS information:", dl_block); |
| 112 | f_shutdown(__BFILE__, __LINE__); |
| 113 | return CS_1; /* make compiler happy */ |
| 114 | } |
| 115 | |
| 116 | /* TS 44.060 sec 12.3 Ack/Nack Description */ |
| 117 | function f_acknackdesc_ack_block(inout AckNackDescription desc, RlcmacDlBlock dl_block, BIT1 final_ack := '0'B) |
| 118 | { |
| 119 | var uint7_t bsn; |
| 120 | var integer i; |
| 121 | var integer inc; |
| 122 | |
| 123 | if (ischosen(dl_block.data)) { |
| 124 | bsn := dl_block.data.mac_hdr.hdr_ext.bsn; |
| 125 | } else { |
| 126 | bsn := dl_block.data_egprs.mac_hdr.bsn1; |
| 127 | } |
| 128 | |
| 129 | inc := bsn - desc.starting_seq_nr + 1; |
| 130 | /* Filling hole? */ |
| 131 | if (bsn < desc.starting_seq_nr) { |
| 132 | desc.receive_block_bitmap[lengthof(desc.receive_block_bitmap) - (desc.starting_seq_nr - bsn)] := int2bit(1, 1); |
| 133 | return; |
| 134 | } |
| 135 | |
| 136 | /* SSN is increased, and so RBB values need to be moved */ |
| 137 | for (i := 0; i < lengthof(desc.receive_block_bitmap) - inc; i := i+1) { |
| 138 | desc.receive_block_bitmap[i] := desc.receive_block_bitmap[i + inc]; |
| 139 | } |
| 140 | for (i := lengthof(desc.receive_block_bitmap) - inc; i < lengthof(desc.receive_block_bitmap) - 1; i := i+1) { |
| 141 | desc.receive_block_bitmap[i] := int2bit(0, 1); |
| 142 | } |
| 143 | /* Now we can set current bit and update SSN */ |
| 144 | desc.starting_seq_nr := bsn + 1; |
| 145 | desc.receive_block_bitmap[lengthof(desc.receive_block_bitmap) - 1] := int2bit(1, 1); |
| 146 | |
| 147 | /* Finally update the final_ack bit as requested: */ |
| 148 | desc.final_ack := final_ack; |
| 149 | } |
| 150 | |
| 151 | /* This function can be used to send DATA.cnf in response to the IUT originated DATA.req. |
| 152 | * NOTE: it's the responsibility of caller to make sure that pcu_msg contains u.data_req. */ |
| 153 | function f_pcuif_tx_data_cnf(in PCUIF_Message pcu_msg) |
| 154 | runs on MS_BTS_IFACE_CT { |
| 155 | var PCUIF_Message pcu_msg_cnf := { |
| 156 | msg_type := PCU_IF_MSG_DATA_CNF, |
| 157 | bts_nr := pcu_msg.bts_nr, |
| 158 | spare := pcu_msg.spare, |
| 159 | u := { data_cnf := pcu_msg.u.data_req } |
| 160 | }; |
| 161 | |
| 162 | /* PCU wants DATA.cnf containing basically everything that was in DATA.req, |
| 163 | * but PCU_IF_SAPI_PCH is a special case - paging group shall be excluded. */ |
| 164 | if (pcu_msg.u.data_req.sapi == PCU_IF_SAPI_PCH) { |
| 165 | pcu_msg_cnf.u.data_cnf.data := substr(pcu_msg.u.data_req.data, 3, |
| 166 | pcu_msg.u.data_req.len - 3); |
| 167 | } |
| 168 | |
| 169 | BTS.send(pcu_msg_cnf); |
| 170 | } |
| 171 | |
| 172 | function f_pcuif_rx_imm_ass(out GsmRrMessage rr_imm_ass, |
| 173 | template PCUIF_Sapi sapi := PCU_IF_SAPI_AGCH, |
Pau Espin Pedrol | 71c08f6 | 2020-05-28 19:44:56 +0700 | [diff] [blame] | 174 | template GsmRrMessage t_imm_ass := ?) |
Pau Espin Pedrol | aedc511 | 2020-05-16 17:30:42 +0200 | [diff] [blame] | 175 | runs on MS_BTS_IFACE_CT return boolean { |
| 176 | var PCUIF_Message pcu_msg; |
| 177 | var octetstring data; |
| 178 | timer T; |
| 179 | |
| 180 | T.start(2.0); |
| 181 | alt { |
Pau Espin Pedrol | 71c08f6 | 2020-05-28 19:44:56 +0700 | [diff] [blame] | 182 | [] BTS.receive(tr_PCUIF_DATA_REQ(bts_nr := 0, trx_nr := 0, ts_nr := 0, |
Pau Espin Pedrol | aedc511 | 2020-05-16 17:30:42 +0200 | [diff] [blame] | 183 | sapi := sapi, data := ?)) -> value pcu_msg { |
| 184 | /* On PCH the payload is prefixed with paging group (3 octets): skip it. |
| 185 | * TODO: add an additional template parameter, so we can match it. */ |
| 186 | if (pcu_msg.u.data_req.sapi == PCU_IF_SAPI_PCH) { |
| 187 | data := substr(pcu_msg.u.data_req.data, 3, pcu_msg.u.data_req.len - 3); |
| 188 | } else { |
| 189 | data := pcu_msg.u.data_req.data; |
| 190 | } |
| 191 | |
| 192 | rr_imm_ass := dec_GsmRrMessage(data); |
| 193 | if (not match(rr_imm_ass, t_imm_ass)) { |
| 194 | /* Not for us? Wait for more. */ |
| 195 | repeat; |
| 196 | } |
| 197 | |
| 198 | log("Rx Immediate Assignment: ", rr_imm_ass); |
Pau Espin Pedrol | 34c940b | 2020-05-28 19:56:11 +0700 | [diff] [blame^] | 199 | |
| 200 | /* Send DATA.cnf back to the IUT (only needed for PCH) */ |
| 201 | if (pcu_msg.u.data_req.sapi == PCU_IF_SAPI_PCH) { |
| 202 | f_pcuif_tx_data_cnf(pcu_msg); |
| 203 | } |
| 204 | |
Pau Espin Pedrol | aedc511 | 2020-05-16 17:30:42 +0200 | [diff] [blame] | 205 | setverdict(pass); |
| 206 | return true; |
| 207 | } |
| 208 | [] BTS.receive { repeat; } |
| 209 | [] T.timeout { |
| 210 | setverdict(fail, "Timeout waiting for Immediate Assignment"); |
Pau Espin Pedrol | fddc20b | 2020-05-28 19:50:29 +0700 | [diff] [blame] | 211 | f_shutdown(__BFILE__, __LINE__); |
Pau Espin Pedrol | aedc511 | 2020-05-16 17:30:42 +0200 | [diff] [blame] | 212 | } |
| 213 | } |
| 214 | |
| 215 | return false; |
| 216 | } |
| 217 | |
| 218 | /* One phase packet access (see 3GPP TS 44.018, table 9.1.8.1) */ |
| 219 | const BIT8 chan_req_def := '01111000'B; |
| 220 | |
| 221 | /* Establish an Uplink TBF by sending RACH.ind towards the PCU */ |
Pau Espin Pedrol | 71c08f6 | 2020-05-28 19:44:56 +0700 | [diff] [blame] | 222 | function f_establish_tbf(out GsmRrMessage rr_imm_ass, |
Pau Espin Pedrol | aedc511 | 2020-05-16 17:30:42 +0200 | [diff] [blame] | 223 | uint16_t ra := bit2int(chan_req_def), |
| 224 | uint8_t is_11bit := 0, |
| 225 | PCUIF_BurstType burst_type := BURST_TYPE_0, |
| 226 | TimingAdvance ta := 0) |
| 227 | runs on MS_BTS_IFACE_CT return boolean { |
| 228 | var uint32_t fn; |
| 229 | |
| 230 | /* FIXME: ask the BTS component to give us the current TDMA fn */ |
| 231 | fn := 1337 + ta; |
| 232 | |
| 233 | /* Send RACH.ind */ |
| 234 | log("Sending RACH.ind on fn=", fn, " with RA=", ra, ", TA=", ta); |
Pau Espin Pedrol | 71c08f6 | 2020-05-28 19:44:56 +0700 | [diff] [blame] | 235 | BTS.send(ts_PCUIF_RACH_IND(bts_nr := 0, trx_nr := 0, ts_nr := 0, |
Pau Espin Pedrol | aedc511 | 2020-05-16 17:30:42 +0200 | [diff] [blame] | 236 | ra := ra, is_11bit := is_11bit, |
| 237 | burst_type := burst_type, |
| 238 | fn := fn, arfcn := 871, |
| 239 | qta := ta * 4)); |
| 240 | |
| 241 | /* 3GPP TS 44.018, table 9.1.8.1, note 2b: Request Reference shall be set to 127 |
| 242 | * when Immediate Assignment is triggered by EGPRS Packet Channel Request. Here |
| 243 | * we assume that 11 bit RA always contains EGPRS Packet Channel Request. */ |
| 244 | if (is_11bit != 0) { ra := 127; } |
| 245 | |
| 246 | /* Expect Immediate (TBF) Assignment on TS0/AGCH */ |
| 247 | return f_pcuif_rx_imm_ass(rr_imm_ass, PCU_IF_SAPI_AGCH, |
Pau Espin Pedrol | 71c08f6 | 2020-05-28 19:44:56 +0700 | [diff] [blame] | 248 | tr_IMM_TBF_ASS(false, ra, fn)); |
Pau Espin Pedrol | aedc511 | 2020-05-16 17:30:42 +0200 | [diff] [blame] | 249 | } |
| 250 | |
| 251 | function f_imm_ass_verify_ul_tbf_ass(in GsmRrMessage rr_imm_ass, out PacketUlAssign ul_tbf_ass, template PacketUlAssign ul_ass := tr_PacketUlDynAssign) |
| 252 | runs on MS_BTS_IFACE_CT { |
| 253 | |
| 254 | /* Make sure we received an UL TBF Assignment */ |
| 255 | if (match(rr_imm_ass, tr_IMM_TBF_ASS(dl := false, rest := tr_IaRestOctets_ULAss(ul_ass)))) { |
| 256 | ul_tbf_ass := rr_imm_ass.payload.imm_ass.rest_octets.hh.pa.uldl.ass.ul; |
| 257 | log("Rx Uplink TBF assignment: ", ul_tbf_ass); |
| 258 | setverdict(pass); |
| 259 | } else { |
| 260 | setverdict(fail, "Failed to match UL TBF Assignment"); |
| 261 | f_shutdown(__BFILE__, __LINE__); |
| 262 | } |
| 263 | } |
| 264 | |
| 265 | function f_imm_ass_verify_dl_tbf_ass(in GsmRrMessage rr_imm_ass, out PacketDlAssign dl_tbf_ass) |
| 266 | runs on MS_BTS_IFACE_CT { |
| 267 | |
| 268 | /* Make sure we received a DL TBF Assignment */ |
| 269 | if (match(rr_imm_ass, tr_IMM_TBF_ASS(dl := true, rest := tr_IaRestOctets_DLAss(?)))) { |
| 270 | dl_tbf_ass := rr_imm_ass.payload.imm_ass.rest_octets.hh.pa.uldl.ass.dl; |
| 271 | log("Rx Downlink TBF assignment: ", dl_tbf_ass); |
| 272 | setverdict(pass); |
| 273 | } else { |
| 274 | setverdict(fail, "Failed to match DL TBF Assignment"); |
| 275 | f_shutdown(__BFILE__, __LINE__); |
| 276 | } |
| 277 | } |
| 278 | |
| 279 | /* Enqueue DATA.ind (both TDMA frame and block numbers to be patched) */ |
| 280 | function f_pcuif_tx_data_ind(octetstring data, int16_t lqual_cb := 0, uint32_t fn := 0) |
| 281 | runs on MS_BTS_IFACE_CT { |
| 282 | var template RAW_PCU_EventParam ev_param := {tdma_fn := ? }; |
| 283 | BTS.send(ts_PCUIF_DATA_IND(bts_nr := 0, trx_nr := 0, ts_nr := 7, block_nr := 0, |
| 284 | sapi := PCU_IF_SAPI_PDTCH, data := data, |
| 285 | fn := fn, arfcn := 871, lqual_cb := lqual_cb)); |
| 286 | if (fn != 0) { |
| 287 | ev_param := {tdma_fn := fn }; |
| 288 | } |
| 289 | BTS.receive(tr_RAW_PCU_EV(TDMA_EV_PDTCH_BLOCK_SENT, ev_param)); |
| 290 | } |
| 291 | |
| 292 | /* Enqueue RTS.req, expect DATA.req with UL ACK from the PCU */ |
| 293 | function f_pcuif_rx_data_req(out PCUIF_Message pcu_msg) |
| 294 | runs on MS_BTS_IFACE_CT { |
| 295 | BTS.send(ts_PCUIF_RTS_REQ(bts_nr := 0, trx_nr := 0, ts_nr := 7, |
| 296 | sapi := PCU_IF_SAPI_PDTCH, fn := 0, |
| 297 | arfcn := 871, block_nr := 0)); |
| 298 | BTS.receive(tr_PCUIF_DATA_REQ(bts_nr := 0, trx_nr := 0, ts_nr := 7, |
| 299 | sapi := PCU_IF_SAPI_PDTCH)) -> value pcu_msg; |
| 300 | } |
| 301 | |
| 302 | /* Expect an Immediate Assignment (paging) from PCU on PCUIF on specified sapi. */ |
| 303 | function f_pcuif_rx_pch_imm_tbf_ass(out GsmRrMessage rr_imm_ass) |
| 304 | runs on MS_BTS_IFACE_CT { |
| 305 | var PCUIF_Message pcu_msg; |
| 306 | var octetstring macblock; |
| 307 | BTS.receive(tr_PCUIF_DATA_REQ(bts_nr := 0, trx_nr := 0, ts_nr := 0, |
| 308 | sapi := PCU_IF_SAPI_PCH)) -> value pcu_msg; |
| 309 | /* First 3 bytes contain paging group: */ |
| 310 | macblock := substr(pcu_msg.u.data_req.data, 3, pcu_msg.u.data_req.len - 3); |
| 311 | rr_imm_ass := dec_GsmRrMessage(macblock); |
| 312 | if (not match(rr_imm_ass, tr_IMM_TBF_ASS())) { |
| 313 | setverdict(fail, "Failed to match Immediate Assignment: ", rr_imm_ass); |
| 314 | f_shutdown(__BFILE__, __LINE__); |
| 315 | } |
| 316 | f_pcuif_tx_data_cnf(pcu_msg); |
| 317 | } |
| 318 | |
| 319 | /* Expect a Paging Request Type 1 from PCU on PCUIF on specified sapi. */ |
| 320 | function f_pcuif_rx_pch_pag_req1(template MobileIdentityV mi1 := ?, |
| 321 | template integer pag_group := ?) |
| 322 | runs on MS_BTS_IFACE_CT return GsmRrMessage { |
| 323 | var GsmRrMessage rr_pag_req1; |
| 324 | var PCUIF_Message pcu_msg; |
| 325 | var octetstring imsi_suff_octstr; |
| 326 | var integer pag_group_rx; |
| 327 | var octetstring macblock; |
| 328 | |
| 329 | BTS.receive(tr_PCUIF_DATA_REQ(bts_nr := 0, trx_nr := 0, ts_nr := 0, |
| 330 | sapi := PCU_IF_SAPI_PCH)) -> value pcu_msg; |
| 331 | |
| 332 | /* First 3 bytes contain IMSI suffix to calculate paging group: */ |
| 333 | imsi_suff_octstr := substr(pcu_msg.u.data_req.data, 0, 3); |
| 334 | pag_group_rx := str2int(oct2char(imsi_suff_octstr[0])) * 100 + |
| 335 | str2int(oct2char(imsi_suff_octstr[1])) * 10 + |
| 336 | str2int(oct2char(imsi_suff_octstr[2])); |
| 337 | |
| 338 | /* Make sure we've got RR Paging Request Type 1 for a given MI */ |
| 339 | macblock := substr(pcu_msg.u.data_req.data, 3, pcu_msg.u.data_req.len - 3); |
| 340 | rr_pag_req1 := dec_GsmRrMessage(macblock); |
| 341 | if (not match(rr_pag_req1, tr_PAG_REQ1(tr_MI_LV(mi1)))) { |
| 342 | setverdict(fail, "Failed to match Paging Request Type 1: ", rr_pag_req1); |
| 343 | f_shutdown(__BFILE__, __LINE__); |
| 344 | } |
| 345 | |
| 346 | /* Make sure that received paging froup matches the expected one */ |
| 347 | if (not match(pag_group_rx, pag_group)) { |
| 348 | setverdict(fail, "Paging group", pag_group_rx, " does not match expected ", pag_group); |
| 349 | f_shutdown(__BFILE__, __LINE__); |
| 350 | } |
| 351 | |
| 352 | f_pcuif_tx_data_cnf(pcu_msg); |
| 353 | return rr_pag_req1; |
| 354 | } |
| 355 | |
| 356 | /* Send one rlcmac UL block adding necessary extra padding at the end. |
| 357 | * returns length of extra padding added at the end, in octets. |
| 358 | * FIXME: Only supports CS-1 so far. |
| 359 | */ |
| 360 | function f_tx_rlcmac_ul_block(template (value) RlcmacUlBlock ul_data, int16_t lqual_cb := 0, uint32_t fn := 0) |
| 361 | runs on MS_BTS_IFACE_CT return integer { |
| 362 | var octetstring data; |
| 363 | var integer padding_len; |
| 364 | /* Encode the payload of DATA.ind */ |
| 365 | data := enc_RlcmacUlBlock(valueof(ul_data)); |
| 366 | padding_len := 23 - lengthof(data); |
| 367 | data := f_pad_oct(data, 23, '00'O); /* CS-1 */ |
| 368 | |
| 369 | /* Enqueue DATA.ind (both TDMA frame and block numbers to be patched) */ |
| 370 | f_pcuif_tx_data_ind(data, lqual_cb, fn); |
| 371 | return padding_len; |
| 372 | } |
| 373 | |
| 374 | function f_tx_rlcmac_ul_n_blocks(uint5_t tfi, inout uint14_t bsn, integer num_blocks := 1, template (omit) GprsTlli tlli := omit) |
| 375 | runs on MS_BTS_IFACE_CT return octetstring { |
| 376 | var octetstring total_payload := ''O; |
| 377 | var template (value) RlcmacUlBlock ul_data := t_RLCMAC_UL_DATA( |
| 378 | tfi := tfi, |
| 379 | cv := 15, /* num UL blocks to be sent (to be overridden in loop) */ |
| 380 | bsn := 0, /* To be generated in loop */ |
| 381 | blocks := { /* To be generated in loop */ }); |
| 382 | |
| 383 | if (not istemplatekind(tlli, "omit")) { |
| 384 | ul_data.data.mac_hdr.tlli_ind := true; |
| 385 | ul_data.data.tlli := tlli; |
| 386 | } |
| 387 | |
| 388 | for (var integer i := 0; i < num_blocks; i := i + 1) { |
| 389 | var integer padding_len; |
| 390 | var octetstring payload := f_rnd_octstring(10); |
| 391 | /* Prepare a new UL block (CV, random payload) */ |
| 392 | var integer cv := num_blocks - i - 1; |
| 393 | if (cv > g_bs_cv_max) { |
| 394 | cv := 15; |
| 395 | } |
| 396 | ul_data.data.mac_hdr.countdown := cv; |
| 397 | ul_data.data.mac_hdr.bsn := bsn + i; |
| 398 | ul_data.data.blocks := { valueof(t_RLCMAC_LLCBLOCK(payload)) }; |
| 399 | padding_len := f_tx_rlcmac_ul_block(ul_data); |
| 400 | total_payload := total_payload & payload & f_pad_oct(''O, padding_len, '00'O); |
| 401 | } |
| 402 | bsn := valueof(ul_data.data.mac_hdr.bsn) + 1; /* update bsn to point to next one */ |
| 403 | return total_payload; |
| 404 | } |
| 405 | |
| 406 | function f_rx_rlcmac_dl_block(out RlcmacDlBlock dl_block, out uint32_t dl_fn, template (present) CodingScheme exp_cs_mcs := ?) |
| 407 | runs on MS_BTS_IFACE_CT { |
| 408 | var PCUIF_Message pcu_msg; |
| 409 | f_pcuif_rx_data_req(pcu_msg); |
| 410 | dl_block := dec_RlcmacDlBlock(pcu_msg.u.data_req.data); |
| 411 | dl_fn := pcu_msg.u.data_req.fn; |
| 412 | |
| 413 | var integer len := lengthof(pcu_msg.u.data_req.data); |
| 414 | var CodingScheme cs_mcs := f_rlcmac_block_len2cs_mcs(len) |
| 415 | if (not match(f_rlcmac_block_len2cs_mcs(len), exp_cs_mcs)) { |
| 416 | setverdict(fail, "Failed to match Coding Scheme exp ", exp_cs_mcs, " vs ", cs_mcs, " (", len, ")"); |
| 417 | f_shutdown(__BFILE__, __LINE__); |
| 418 | } |
| 419 | } |
| 420 | |
| 421 | function f_rx_rlcmac_dl_block_exp_ack_nack(out RlcmacDlBlock dl_block, out uint32_t poll_fn) |
| 422 | runs on MS_BTS_IFACE_CT { |
| 423 | var uint32_t dl_fn; |
| 424 | |
| 425 | f_rx_rlcmac_dl_block(dl_block, dl_fn); |
Pau Espin Pedrol | 692222c | 2020-05-17 00:25:37 +0200 | [diff] [blame] | 426 | if (match(dl_block, tr_RLCMAC_UL_ACK_NACK_GPRS(ul_tfi := ?)) or |
| 427 | match(dl_block, tr_RLCMAC_UL_ACK_NACK_EGPRS(ul_tfi := ?))) { |
| 428 | poll_fn := f_rrbp_ack_fn(dl_fn, dl_block.ctrl.mac_hdr.rrbp); |
| 429 | return; |
Pau Espin Pedrol | aedc511 | 2020-05-16 17:30:42 +0200 | [diff] [blame] | 430 | } |
Pau Espin Pedrol | 692222c | 2020-05-17 00:25:37 +0200 | [diff] [blame] | 431 | setverdict(fail, "Failed to match Packet Uplink ACK / NACK:", dl_block); |
| 432 | f_shutdown(__BFILE__, __LINE__); |
Pau Espin Pedrol | aedc511 | 2020-05-16 17:30:42 +0200 | [diff] [blame] | 433 | } |
| 434 | |
| 435 | function f_rx_rlcmac_dl_block_exp_dummy(out RlcmacDlBlock dl_block) |
| 436 | runs on MS_BTS_IFACE_CT { |
| 437 | var uint32_t dl_fn; |
| 438 | |
| 439 | f_rx_rlcmac_dl_block(dl_block, dl_fn); |
| 440 | if (not match(dl_block, tr_RLCMAC_DUMMY_CTRL())) { |
| 441 | setverdict(fail, "Failed to match Packet DUMMY DL"); |
| 442 | f_shutdown(__BFILE__, __LINE__); |
| 443 | } |
| 444 | } |
| 445 | |
| 446 | function f_rx_rlcmac_dl_block_exp_pkt_ass(out RlcmacDlBlock dl_block, out uint32_t poll_fn) |
| 447 | runs on MS_BTS_IFACE_CT { |
| 448 | var uint32_t dl_fn; |
| 449 | |
| 450 | f_rx_rlcmac_dl_block(dl_block, dl_fn); |
| 451 | if (not match(dl_block, tr_RLCMAC_DL_PACKET_ASS())) { |
| 452 | setverdict(fail, "Failed to match Packet Downlink Assignment"); |
| 453 | f_shutdown(__BFILE__, __LINE__); |
| 454 | } |
| 455 | |
| 456 | poll_fn := f_rrbp_ack_fn(dl_fn, dl_block.ctrl.mac_hdr.rrbp); |
| 457 | } |
| 458 | |
| 459 | function f_rx_rlcmac_dl_block_exp_pkt_ul_ass(out RlcmacDlBlock dl_block, out uint32_t poll_fn) |
| 460 | runs on MS_BTS_IFACE_CT { |
| 461 | var uint32_t dl_fn; |
| 462 | |
| 463 | f_rx_rlcmac_dl_block(dl_block, dl_fn); |
| 464 | if (not match(dl_block, tr_RLCMAC_UL_PACKET_ASS())) { |
| 465 | setverdict(fail, "Failed to match Packet Uplink Assignment"); |
| 466 | f_shutdown(__BFILE__, __LINE__); |
| 467 | } |
| 468 | |
| 469 | poll_fn := f_rrbp_ack_fn(dl_fn, dl_block.ctrl.mac_hdr.rrbp); |
| 470 | } |
| 471 | |
| 472 | function f_rx_rlcmac_dl_block_exp_pkt_dl_ass(out RlcmacDlBlock dl_block, out uint32_t poll_fn) |
| 473 | runs on MS_BTS_IFACE_CT { |
| 474 | var uint32_t dl_fn; |
| 475 | |
| 476 | f_rx_rlcmac_dl_block(dl_block, dl_fn); |
| 477 | if (not match(dl_block, tr_RLCMAC_DL_PACKET_ASS())) { |
| 478 | setverdict(fail, "Failed to match Packet Downlink Assignment"); |
| 479 | f_shutdown(__BFILE__, __LINE__); |
| 480 | } |
| 481 | |
| 482 | poll_fn := f_rrbp_ack_fn(dl_fn, dl_block.ctrl.mac_hdr.rrbp); |
| 483 | } |
| 484 | |
| 485 | |
| 486 | function f_rx_rlcmac_dl_block_exp_pkt_pag_req(out RlcmacDlBlock dl_block) |
| 487 | runs on MS_BTS_IFACE_CT { |
| 488 | var uint32_t dl_fn; |
| 489 | |
| 490 | f_rx_rlcmac_dl_block(dl_block, dl_fn); |
| 491 | if (not match(dl_block, tr_RLCMAC_PACKET_PAG_REQ())) { |
| 492 | setverdict(fail, "Failed to match Packet Paging Request: ", dl_block, " vs ", tr_RLCMAC_PACKET_PAG_REQ()); |
| 493 | f_shutdown(__BFILE__, __LINE__); |
| 494 | } |
| 495 | } |
| 496 | |
| 497 | /* This function does what could probably be done with templates */ |
| 498 | function f_rlcmac_dl_block_verify_data_gprs(in RlcmacDlDataBlock data_block, |
| 499 | template (present) octetstring data := ?, |
| 500 | template (present) uint7_t exp_bsn := ?, |
| 501 | template (present) CodingScheme exp_cs := ?) |
| 502 | runs on MS_BTS_IFACE_CT { |
| 503 | if (not match(data_block.mac_hdr.hdr_ext.bsn, exp_bsn)) { |
| 504 | setverdict(fail, "DL block BSN doesn't match: ", |
| 505 | data_block.mac_hdr.hdr_ext.bsn, " vs exp ", exp_bsn); |
| 506 | } |
| 507 | |
| 508 | if (lengthof(data_block.blocks) < 1) { |
| 509 | setverdict(fail, "DL block has no LLC payload: ", data_block); |
| 510 | f_shutdown(__BFILE__, __LINE__); |
| 511 | } |
| 512 | |
| 513 | if (not match(data_block.blocks[0].payload, data)) { |
| 514 | setverdict(fail, "Failed to match content of LLC payload in DL Block: ", |
| 515 | data_block.blocks[0].payload, " vs ", data); |
| 516 | f_shutdown(__BFILE__, __LINE__); |
| 517 | } |
| 518 | |
| 519 | /* Check next data blocks contain dummy frames */ |
| 520 | if (lengthof(data_block.blocks) > 1 and substr(data_block.blocks[1].payload, 0, 3) != '43C001'O) { |
| 521 | setverdict(fail, "Second data payload is not a dummy frame: ", |
| 522 | data_block.blocks[1].payload); |
| 523 | f_shutdown(__BFILE__, __LINE__); |
| 524 | } |
| 525 | |
| 526 | /* TODO: check exp_cs */ |
| 527 | } |
| 528 | |
| 529 | /* This function does what could probably be done with templates */ |
| 530 | function f_rlcmac_dl_block_verify_data_egprs(in RlcmacDlEgprsDataBlock data_block, |
| 531 | template (present) octetstring data := ?, |
| 532 | template (present) uint14_t exp_bsn := ?, |
| 533 | template (present) CodingScheme exp_cs := ?) |
| 534 | runs on MS_BTS_IFACE_CT { |
| 535 | if (not match(data_block.mac_hdr.bsn1, exp_bsn)) { |
| 536 | setverdict(fail, "DL block BSN doesn't match: ", |
| 537 | data_block.mac_hdr.bsn1, " vs exp ", exp_bsn); |
| 538 | } |
| 539 | |
| 540 | if (lengthof(data_block.blocks) < 1) { |
| 541 | setverdict(fail, "DL block has no LLC payload: ", data_block); |
| 542 | f_shutdown(__BFILE__, __LINE__); |
| 543 | } |
| 544 | |
| 545 | if (not match(data_block.blocks[0].payload, data)) { |
| 546 | setverdict(fail, "Failed to match content of LLC payload in DL Block: ", |
| 547 | data_block.blocks[0].payload, " vs ", data); |
| 548 | f_shutdown(__BFILE__, __LINE__); |
| 549 | } |
| 550 | |
| 551 | /* Check next data blocks contain dummy frames */ |
| 552 | if (lengthof(data_block.blocks) > 1 and substr(data_block.blocks[1].payload, 0, 3) != '43C001'O) { |
| 553 | setverdict(fail, "Second data payload is not a dummy frame: ", |
| 554 | data_block.blocks[1].payload); |
| 555 | f_shutdown(__BFILE__, __LINE__); |
| 556 | } |
| 557 | |
| 558 | /* 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. |
| 559 | See wireshark's egprs_Header_type1_coding_puncturing_scheme_to_mcs. */ |
| 560 | } |
| 561 | |
| 562 | /* High level (task specific) helper for receiving and matching GPRS/EGPRS data blocks */ |
| 563 | function f_rx_rlcmac_dl_block_exp_data(out RlcmacDlBlock dl_block, out uint32_t dl_fn, |
| 564 | template (present) octetstring data := ?, |
| 565 | template (present) uint7_t exp_bsn := ?, |
| 566 | template (present) CodingScheme exp_cs := ?) |
| 567 | runs on MS_BTS_IFACE_CT { |
| 568 | /* FIXME: ideally we should use an alt statement with timeout here, rather than |
| 569 | * having +100500 layers of abstraction. This would facilitate developing the |
| 570 | * multi-TBF/-TRX/-BTS tests, where you cannot expect that the first received |
| 571 | * block is exactly what you need. */ |
| 572 | f_rx_rlcmac_dl_block(dl_block, dl_fn); |
| 573 | |
| 574 | /* Make sure it's either GPRS or EGPRS data block */ |
| 575 | if (not match(dl_block, tr_RLCMAC_DATA)) { |
| 576 | setverdict(fail, "Failed to match DL DATA: ", dl_block, " vs ", tr_RLCMAC_DATA); |
| 577 | f_shutdown(__BFILE__, __LINE__); |
| 578 | } |
| 579 | |
| 580 | if (ischosen(dl_block.data_egprs)) { |
| 581 | f_rlcmac_dl_block_verify_data_egprs(dl_block.data_egprs, data, exp_bsn, exp_cs); |
| 582 | } else if (ischosen(dl_block.data)) { |
| 583 | f_rlcmac_dl_block_verify_data_gprs(dl_block.data, data, exp_bsn, exp_cs); |
| 584 | } else { |
| 585 | /* Should not happen, but the caller may theoretically give us a template for CTRL */ |
| 586 | setverdict(fail, "DL block is neither GPRS nor EGPRS data block: ", dl_block); |
| 587 | f_shutdown(__BFILE__, __LINE__); |
| 588 | } |
| 589 | } |
| 590 | |
| 591 | function f_dl_block_ack_fn(in RlcmacDlBlock dl_block, uint32_t dl_fn) |
| 592 | runs on MS_BTS_IFACE_CT return uint32_t { |
| 593 | var boolean rrbp_valid; |
| 594 | var MacRrbp rrbp; |
| 595 | |
| 596 | /* The argument must be either a GPRS or EGPRS data block */ |
| 597 | if (ischosen(dl_block.data_egprs)) { |
| 598 | rrbp_valid := true; /* always valid */ |
| 599 | rrbp := dl_block.data_egprs.mac_hdr.rrbp; |
| 600 | } else if (ischosen(dl_block.data)) { |
| 601 | rrbp_valid := dl_block.data.mac_hdr.mac_hdr.rrbp_valid; |
| 602 | rrbp := dl_block.data.mac_hdr.mac_hdr.rrbp; |
| 603 | } else { |
| 604 | rrbp_valid := dl_block.ctrl.mac_hdr.rrbp_valid; |
| 605 | rrbp := dl_block.ctrl.mac_hdr.rrbp; |
| 606 | } |
| 607 | |
| 608 | /* Make sure that the given block really needs to be ACKnowledged */ |
| 609 | if (not rrbp_valid) { |
| 610 | setverdict(fail, "DL block shall not be ACKnowledged, field RRBP is not valid"); |
| 611 | f_shutdown(__BFILE__, __LINE__); |
| 612 | } |
| 613 | |
| 614 | return f_rrbp_ack_fn(dl_fn, rrbp); |
| 615 | } |
| 616 | |
| 617 | function f_pkt_paging_match_tmsi(in PacketPagingReq req, template GsmTmsi tmsi) |
| 618 | runs on MS_BTS_IFACE_CT { |
| 619 | if (not match(req.repeated_pageinfo.cs.tmsi, tmsi)) { |
| 620 | setverdict(fail, "Mobile Identity (TMSI/P-TMSI) mismatch: ", |
| 621 | "expected: ", tmsi, "got: ", req.repeated_pageinfo.cs.tmsi); |
| 622 | f_shutdown(__BFILE__, __LINE__); |
| 623 | } |
| 624 | } |
| 625 | |
| 626 | } |