blob: ffd60a78ee5b584984e595aff60fc5ed689afc2c [file] [log] [blame]
Harald Welte714ded92017-12-08 14:00:22 +01001module RSL_Emulation {
2
Harald Welte35bb7162018-01-03 21:07:52 +01003/* RSL Emulation, runs on top of IPA_Emulation. It multiplexes/demultiplexes
4 * the individual connections (logical channels), so there can be separate TTCN-3 components
5 * handling each of the connections.
6 *
7 * The RSL_Emulation.main() function processes RSL messages from the IPA demultiplex
8 * stack via the IPA_RSL_PT, and dispatches them to the per-connection components.
9 *
10 * Outbound RSL connections are initiated by sending a RSLDC_ChanRqd primitive
11 * to the component running the RSL_Emulation.main() function.
12 *
Harald Weltead2647b2018-03-22 19:53:55 +010013 * in case we're emulating the BTS-side of RSL: We have no clue as to which particular logical
14 * channel the BSC may decide to activate at which point, so we have to blindly acknowledge all
15 * channel activations. Still, a test case might be interested in the exact assignment message to
16 * determine the type of activation, encryption, codec flags etc. at some later point, when it's
17 * clear for which transaction this activation happened. We keep this in the LastChanAct table.
18 *
19 * (C) 2017-2018 by Harald Welte <laforge@gnumonks.org>
Harald Welte35bb7162018-01-03 21:07:52 +010020 * All rights reserved.
21 *
22 * Released under the terms of GNU General Public License, Version 2 or
23 * (at your option) any later version.
Harald Welte34b5a952019-05-27 11:54:11 +020024 *
25 * SPDX-License-Identifier: GPL-2.0-or-later
Harald Welte35bb7162018-01-03 21:07:52 +010026 */
27
Pau Espin Pedrola07cfd92018-10-22 15:54:41 +020028import from Misc_Helpers all;
Harald Welte714ded92017-12-08 14:00:22 +010029import from General_Types all;
30import from Osmocom_Types all;
31import from GSM_Types all;
32import from GSM_RR_Types all;
33import from RSL_Types all;
34import from IPA_Types all;
35import from IPA_Emulation all;
36
37
38/* General "base class" component definition, of which specific implementations
39 * derive themselves by means of the "extends" feature */
40type component RSL_DchanHdlr {
41 /* port facing up towards dedicated channel handler */
42 port RSL_DCHAN_PT RSL;
Harald Weltef70df652018-01-29 22:00:23 +010043 port RSLEM_PROC_PT RSL_PROC;
Harald Welte714ded92017-12-08 14:00:22 +010044 var RslChannelNr g_chan_nr;
Harald Welte421e4d42018-02-12 20:04:50 +010045 /* second BTS / DChan during hand-over */
46 port RSL_DCHAN_PT RSL1;
47 port RSLEM_PROC_PT RSL1_PROC;
Neels Hofmeyr91401012019-07-11 00:42:35 +020048 port RSL_DCHAN_PT RSL2;
49 port RSLEM_PROC_PT RSL2_PROC;
Harald Welte714ded92017-12-08 14:00:22 +010050};
51
52type record RSLDC_ChanRqd {
53 OCT1 ra,
Pau Espin Pedrol6451b042018-10-24 20:36:16 +020054 GsmFrameNumber fn optional
Harald Welte714ded92017-12-08 14:00:22 +010055};
56
Pau Espin Pedrol6451b042018-10-24 20:36:16 +020057template (value) RSLDC_ChanRqd ts_RSLDC_ChanRqd(OCT1 ra, GsmFrameNumber fn) := {
Harald Welte714ded92017-12-08 14:00:22 +010058 ra := ra,
59 fn := fn
60}
61
Pau Espin Pedrol6451b042018-10-24 20:36:16 +020062template (value) RSLDC_ChanRqd ts_RSLDC_ChanRqd_anyFN(OCT1 ra) := {
63 ra := ra,
64 fn := omit
65}
66
Harald Welte714ded92017-12-08 14:00:22 +010067type port RSL_DCHAN_PT message {
68 inout RSLDC_ChanRqd, RSL_Message;
69} with { extension "internal" };
70
Harald Welte1c02fd12018-02-19 19:20:47 +010071type port RSL_CCHAN_PT message {
Harald Weltebb6aed32018-02-21 12:19:18 +010072 inout ASP_RSL_Unitdata, ASP_IPA_Event;
Harald Welte1c02fd12018-02-19 19:20:47 +010073} with { extension "internal" };
74
75
Harald Weltef70df652018-01-29 22:00:23 +010076signature RSLEM_register(uint8_t trx_nr, RslChannelNr chan_nr, RSL_DchanHdlr hdlr);
Harald Welte1909f462018-01-29 22:29:29 +010077signature RSLEM_unregister(uint8_t trx_nr, RslChannelNr chan_nr, RSL_DchanHdlr hdlr);
Harald Welte70b52c92018-02-12 20:47:31 +010078signature RSLEM_suspend(boolean suspend);
Harald Weltead2647b2018-03-22 19:53:55 +010079signature RSLEM_get_last_act(in uint8_t trx_nr, in RslChannelNr chan_nr, out RSL_Message chan_act);
Harald Weltef70df652018-01-29 22:00:23 +010080
81type port RSLEM_PROC_PT procedure {
Harald Weltead2647b2018-03-22 19:53:55 +010082 inout RSLEM_register, RSLEM_unregister, RSLEM_suspend, RSLEM_get_last_act;
Harald Weltef70df652018-01-29 22:00:23 +010083} with { extension "internal" };
84
Harald Welte714ded92017-12-08 14:00:22 +010085/***********************************************************************
86 * Client Component for a single dedicated channel
87 ***********************************************************************/
88
89private function f_rx_or_fail(template RSL_Message exp_rx) runs on RSL_DchanHdlr return RSL_Message
90{
91 var RSL_Message rx_rsl;
92 timer T := 10.0;
93
94 /* request a channel to be established */
95 T.start;
96 alt {
97 [] RSL.receive(exp_rx) -> value rx_rsl {
98 T.stop;
99 return rx_rsl;
100 }
101 [] RSL.receive {
102 setverdict(fail, "Unexpected RSL message on DCHAN");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200103 mtc.stop;
Harald Welte714ded92017-12-08 14:00:22 +0100104 }
105 [] T.timeout {
106 setverdict(fail, "Timeout waiting for RSL on DCHAN");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200107 mtc.stop;
Harald Welte714ded92017-12-08 14:00:22 +0100108 }
109 }
110 /* never reached */
111 return rx_rsl;
112}
113
114/* establish a dedicated channel using 'ra' */
115function f_chan_est(OCT1 ra, octetstring est_l3, template RslLinkId link_id, GsmFrameNumber fn := 23)
116runs on RSL_DchanHdlr {
117 var RSL_Message rx_rsl;
118 var GsmRrMessage rr;
119
120 /* request a channel to be established */
121 RSL.send(ts_RSLDC_ChanRqd(ra, fn));
122 /* expect immediate assignment */
123 rx_rsl := f_rx_or_fail(tr_RSL_IMM_ASSIGN);
124 rr := dec_GsmRrMessage(rx_rsl.ies[1].body.full_imm_ass_info.payload);
125 g_chan_nr := rr.payload.imm_ass.chan_desc.chan_nr;
126 RSL.send(ts_RSL_EST_IND(g_chan_nr, valueof(link_id), est_l3));
127}
128
129function f_deact_chan(RSL_Cause cause) runs on RSL_DchanHdlr
130{
131 var RSL_Message rx_rsl;
132
133 RSL.send(ts_RSL_CONN_FAIL_IND(g_chan_nr, cause));
134 rx_rsl := f_rx_or_fail(tr_RSL_MsgTypeD(RSL_MT_RF_CHAN_REL));
135 /* FIXME RSL.send(ts_RSL_RF_CHAN_REL_ACK()) */
136}
137
138
139
140/***********************************************************************
141 * Main Component
142 ***********************************************************************/
143
144private type record ConnectionData {
145 /* component reference to the client component */
146 RSL_DchanHdlr comp_ref,
147 /* RSL (dedicated) Channel number we're handling */
148 uint8_t trx_nr optional,
149 IpaStreamId stream_id optional,
150 RslChannelNr chan_nr optional,
151 /* Random Reference */
152 OCT1 ra optional,
153 GsmFrameNumber ra_fn optional
154};
155
156private function f_cid_by_comp_ref(RSL_DchanHdlr comp_ref)
157runs on RSL_Emulation_CT return integer {
158 var integer i;
159 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
160 if (ispresent(ConnectionTable[i].comp_ref) and
161 ConnectionTable[i].comp_ref == comp_ref) {
162 return i;
163 }
164 }
165 log("No Dchan handler for ", comp_ref);
166 return -1;
167}
168
169private function f_cid_by_chan_nr(uint8_t trx_nr, RslChannelNr chan_nr)
170runs on RSL_Emulation_CT return integer {
171 var integer i;
172 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
173 if (ispresent(ConnectionTable[i].chan_nr) and
174 ConnectionTable[i].chan_nr == chan_nr and ConnectionTable[i].trx_nr == trx_nr) {
175 return i;
176 }
177 }
178 log("No Dchan handler for ", trx_nr, chan_nr);
179 return -1;
180}
181
182private function f_cid_by_ra_fn(OCT1 ra, GsmFrameNumber fn)
183runs on RSL_Emulation_CT return integer {
184 var integer i;
185 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
186 if (ispresent(ConnectionTable[i].ra) and
187 ConnectionTable[i].ra == ra and ConnectionTable[i].ra_fn == fn) {
188 return i;
189 }
190 }
191 log("No Dchan handler for ", ra, fn);
192 return -1;
193}
194
Pau Espin Pedrol6451b042018-10-24 20:36:16 +0200195/* Matches by only RA if FN is ommited in one of the connections allocated */
196private function f_cid_by_ra_fn2(OCT1 ra, RSL_IE_FrameNumber fn)
197runs on RSL_Emulation_CT return integer {
198 var integer i;
199 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
200 if (ispresent(ConnectionTable[i].ra) and
201 ConnectionTable[i].ra == ra) {
202 if (not ispresent(ConnectionTable[i].ra_fn) or
203 fn == valueof(ts_RSL_IE_FrameNumber(ConnectionTable[i].ra_fn))) {
204 return i;
205 }
206 }
207 }
208 log("No Dchan handler for ", ra, fn);
209 return -1;
210}
211
Harald Welte714ded92017-12-08 14:00:22 +0100212/* create an ew client with given RA and FN */
Pau Espin Pedrol6451b042018-10-24 20:36:16 +0200213private function f_cid_create(OCT1 ra, template (omit) GsmFrameNumber fn, RSL_DchanHdlr comp_ref)
Harald Welte930d0a72018-03-22 22:08:40 +0100214runs on RSL_Emulation_CT {
Harald Welte714ded92017-12-08 14:00:22 +0100215 var integer i;
216 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
Harald Weltef70df652018-01-29 22:00:23 +0100217 if (not ispresent(ConnectionTable[i].ra) and
218 not ispresent(ConnectionTable[i].trx_nr)) {
Harald Welte714ded92017-12-08 14:00:22 +0100219 ConnectionTable[i].ra := ra;
Pau Espin Pedrol6451b042018-10-24 20:36:16 +0200220 if (ispresent(fn)) {
221 ConnectionTable[i].ra_fn := valueof(fn);
222 } else {
223 ConnectionTable[i].ra_fn := omit;
224 }
Harald Welte714ded92017-12-08 14:00:22 +0100225 ConnectionTable[i].comp_ref := comp_ref;
Harald Welte930d0a72018-03-22 22:08:40 +0100226 return;
Harald Welte714ded92017-12-08 14:00:22 +0100227 }
228 }
Daniel Willmann8273fb92018-07-05 17:31:20 +0200229 testcase.stop("No free entry in conn table for ", ra, fn);
Harald Welte714ded92017-12-08 14:00:22 +0100230}
231
Vadim Yanitskiyefc94132020-05-24 04:26:45 +0700232/* create a new client with given RA and FN */
Harald Weltef70df652018-01-29 22:00:23 +0100233private function f_cid_create_cnr(uint8_t trx_nr, RslChannelNr chan_nr, RSL_DchanHdlr comp_ref)
Harald Welte930d0a72018-03-22 22:08:40 +0100234runs on RSL_Emulation_CT {
Harald Weltef70df652018-01-29 22:00:23 +0100235 var integer i;
236 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
237 if (not ispresent(ConnectionTable[i].ra) and
238 not ispresent(ConnectionTable[i].trx_nr)) {
239 ConnectionTable[i].stream_id := f_streamId_by_trx(trx_nr);
240 ConnectionTable[i].trx_nr := trx_nr;
241 ConnectionTable[i].chan_nr := chan_nr;
242 ConnectionTable[i].comp_ref := comp_ref;
Harald Welte930d0a72018-03-22 22:08:40 +0100243 return;
Harald Weltef70df652018-01-29 22:00:23 +0100244 }
245 }
Daniel Willmann8273fb92018-07-05 17:31:20 +0200246 testcase.stop("No free entry in conn table for ", trx_nr, chan_nr, comp_ref);
Harald Weltef70df652018-01-29 22:00:23 +0100247}
248
249
Vadim Yanitskiyefc94132020-05-24 04:26:45 +0700250/* delete client with given RA and FN */
Harald Weltef70df652018-01-29 22:00:23 +0100251private function f_cid_delete_cnr(IpaStreamId stream_id, RslChannelNr chan_nr, RSL_DchanHdlr comp_ref)
252runs on RSL_Emulation_CT return integer {
253 var integer i;
254 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
255 if (ConnectionTable[i].comp_ref == null) {
256 continue;
257 }
258 if (ConnectionTable[i].stream_id == stream_id and
259 ConnectionTable[i].chan_nr == chan_nr and
260 ConnectionTable[i].comp_ref == comp_ref) {
261 f_cid_clear(i);
262 }
263 }
264 log("Unable to find entry to delete for ", stream_id, chan_nr, comp_ref);
265 return -1;
266}
267
268
Harald Welte714ded92017-12-08 14:00:22 +0100269private function f_cid_clear(integer cid)
270runs on RSL_Emulation_CT {
271 ConnectionTable[cid].ra := omit;
272 ConnectionTable[cid].ra_fn := omit;
Harald Welte714ded92017-12-08 14:00:22 +0100273 ConnectionTable[cid].trx_nr := omit;
274 ConnectionTable[cid].stream_id := omit;
275 ConnectionTable[cid].chan_nr := omit;
Harald Weltef70df652018-01-29 22:00:23 +0100276 ConnectionTable[cid].comp_ref := null;
Harald Welte714ded92017-12-08 14:00:22 +0100277}
278
Harald Weltead2647b2018-03-22 19:53:55 +0100279/* last activation for a given channel number */
280type record LastActData {
281 uint8_t trx_nr optional,
282 RslChannelNr chan_nr optional,
283 RSL_Message chan_act optional
284}
285
286private function f_store_last_act_data(uint8_t trx_nr, RslChannelNr chan_nr, RSL_Message chan_act)
287runs on RSL_Emulation_CT {
288 for (var integer i := 0; i < sizeof(LastActTable); i := i+1) {
289 if (not ispresent(LastActTable[i].chan_nr) or
290 (LastActTable[i].chan_nr == chan_nr and LastActTable[i].trx_nr == trx_nr)) {
291 LastActTable[i].trx_nr := trx_nr;
292 LastActTable[i].chan_nr := chan_nr;
293 LastActTable[i].chan_act := chan_act;
294 return;
295 }
296 }
Daniel Willmann8273fb92018-07-05 17:31:20 +0200297 testcase.stop("No space left in LastActTable to store chan_act for ", chan_nr);
Harald Weltead2647b2018-03-22 19:53:55 +0100298}
299
300private function f_lookup_last_act(uint8_t trx_nr, RslChannelNr chan_nr)
301runs on RSL_Emulation_CT return RSL_Message {
302 for (var integer i := 0; i < sizeof(LastActTable); i := i+1) {
303 if (ispresent(LastActTable[i].chan_nr) and LastActTable[i].chan_nr == chan_nr
304 and LastActTable[i].trx_nr == trx_nr) {
305 return LastActTable[i].chan_act;
306 }
307 }
Daniel Willmann8273fb92018-07-05 17:31:20 +0200308 testcase.stop("No LastActTable entry found for TRX ", trx_nr, " ", chan_nr);
Harald Weltead2647b2018-03-22 19:53:55 +0100309}
310
311private function f_last_act_table_init() runs on RSL_Emulation_CT {
312 for (var integer i := 0; i < sizeof(LastActTable); i := i+1) {
313 LastActTable[i] := { omit, omit, omit };
314 }
315}
316
Harald Welte714ded92017-12-08 14:00:22 +0100317type component RSL_Emulation_CT {
318 /* port facing down towards IPA emulation */
319 port IPA_RSL_PT IPA_PT;
320 /* port facing up towards dedicated channel handler */
321 port RSL_DCHAN_PT CLIENT_PT;
Harald Weltef70df652018-01-29 22:00:23 +0100322 port RSLEM_PROC_PT RSL_PROC;
Harald Welte714ded92017-12-08 14:00:22 +0100323
Harald Welte1c02fd12018-02-19 19:20:47 +0100324 /* port for Common Channel / TRX Management */
325 port RSL_CCHAN_PT CCHAN_PT;
326
Harald Welte714ded92017-12-08 14:00:22 +0100327 /* state of all concurrent connections / dedicated channels */
328 var ConnectionData ConnectionTable[64];
Harald Weltead2647b2018-03-22 19:53:55 +0100329
330 /* last RSL CHAN ACT for each chan_nr */
331 var LastActData LastActTable[64];
Harald Welte714ded92017-12-08 14:00:22 +0100332}
333
334
Harald Welte714ded92017-12-08 14:00:22 +0100335private function f_trx_by_streamId(IpaStreamId id) return integer {
336 return enum2int(id);
337}
338
Harald Weltef70df652018-01-29 22:00:23 +0100339private function f_streamId_by_trx(uint8_t trx_nr) return IpaStreamId {
340 select (trx_nr) {
341 case (0) { return IPAC_PROTO_RSL_TRX0; }
342 case (1) { return IPAC_PROTO_RSL_TRX1; }
343 case (2) { return IPAC_PROTO_RSL_TRX2; }
344 case (3) { return IPAC_PROTO_RSL_TRX3; }
345 }
Daniel Willmanna6ea2ef2018-07-24 09:55:52 +0200346 setverdict(fail, "Unknown stream ID ", trx_nr);
347 mtc.stop;
Harald Weltef70df652018-01-29 22:00:23 +0100348}
349
Harald Welte714ded92017-12-08 14:00:22 +0100350
Harald Welte1c02fd12018-02-19 19:20:47 +0100351function main(boolean bts_role := true) runs on RSL_Emulation_CT {
Harald Weltebb6aed32018-02-21 12:19:18 +0100352 var ASP_IPA_Event evt;
Harald Welte714ded92017-12-08 14:00:22 +0100353 var ASP_RSL_Unitdata rx_rsl;
354 var RSL_Message rx_rsl_msg;
355 var RSLDC_ChanRqd chan_rqd;
356 var RSL_DchanHdlr vc_conn;
Harald Weltef70df652018-01-29 22:00:23 +0100357 var RslChannelNr chan_nr;
358 var uint8_t trx_nr;
Harald Welte714ded92017-12-08 14:00:22 +0100359 var integer cid;
360 var integer i;
Harald Welte70b52c92018-02-12 20:47:31 +0100361 /* special synchronization handling during hand-over */
362 var boolean dchan_suspended := false;
Harald Welte714ded92017-12-08 14:00:22 +0100363
Daniel Willmann17f970f2018-01-17 12:03:19 +0100364 f_conn_table_init();
Harald Weltead2647b2018-03-22 19:53:55 +0100365 f_last_act_table_init();
Daniel Willmann17f970f2018-01-17 12:03:19 +0100366
Harald Welte714ded92017-12-08 14:00:22 +0100367 while (true) {
368 alt {
Vadim Yanitskiya2afacc2020-05-18 21:16:19 +0700369 [bts_role] IPA_PT.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_UP)) {
Harald Weltebb6aed32018-02-21 12:19:18 +0100370 }
Vadim Yanitskiya2afacc2020-05-18 21:16:19 +0700371 [not bts_role] IPA_PT.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_UP)) -> value evt {
Harald Weltebb6aed32018-02-21 12:19:18 +0100372 CCHAN_PT.send(evt);
Harald Welte624f9632017-12-16 19:26:04 +0100373 }
Vadim Yanitskiya2afacc2020-05-18 21:16:19 +0700374 [bts_role] IPA_PT.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_DOWN)) {
Pau Espin Pedrola07cfd92018-10-22 15:54:41 +0200375 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Lost IPA connection!");
376
377 }
Vadim Yanitskiya2afacc2020-05-18 21:16:19 +0700378 [not bts_role] IPA_PT.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_DOWN)) {
Pau Espin Pedrola07cfd92018-10-22 15:54:41 +0200379 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Lost IPA connection!");
380 }
Vadim Yanitskiya2afacc2020-05-18 21:16:19 +0700381 [bts_role] IPA_PT.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_ID_ACK)) {
Vadim Yanitskiy9b4e3562020-05-25 21:40:52 +0700382 IPA_PT.send(ts_ASP_RSL_UD(ts_RSL_PAGING_LOAD_IND(23)));
Harald Welte714ded92017-12-08 14:00:22 +0100383 }
Vadim Yanitskiya2afacc2020-05-18 21:16:19 +0700384 [not bts_role] IPA_PT.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_ID_ACK)) { }
Vadim Yanitskiya2c12c92020-05-25 22:08:23 +0700385 [bts_role] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_IMM_ASSIGN)) -> value rx_rsl {
Harald Welte714ded92017-12-08 14:00:22 +0100386 var GsmRrMessage rr;
387 var OCT1 ra;
388 var GsmFrameNumber fn;
Harald Welte714ded92017-12-08 14:00:22 +0100389 rr := dec_GsmRrMessage(rx_rsl.rsl.ies[1].body.full_imm_ass_info.payload);
390 if (ischosen(rr.payload.imm_ass)) {
391 ra := bit2oct(rr.payload.imm_ass.req_ref.ra);
392 fn := 23; //FIXME(rr.payload.imm_ass);
393 /* lookup client based on RA+time, deliver to client */
394 cid := f_cid_by_ra_fn(ra, fn);
395 if (cid == -1) {
396 setverdict(fail, "IMM ASS for unknown DChan");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200397 mtc.stop;
Harald Welte714ded92017-12-08 14:00:22 +0100398 }
399 /* update client with trx_nr */
400 ConnectionTable[cid].trx_nr := f_trx_by_streamId(rx_rsl.streamId);
401 ConnectionTable[cid].stream_id := rx_rsl.streamId;
402 /* update client with chan_nr */
403 ConnectionTable[cid].chan_nr := rr.payload.imm_ass.chan_desc.chan_nr;
404 /* TODO: add timer to time-out ConnectionTable entries which
405 * never get followed-up to */
406 CLIENT_PT.send(rx_rsl.rsl) to ConnectionTable[cid].comp_ref;
407 } else if (ischosen(rr.payload.imm_ass_rej)) {
408 for (i := 0; i < sizeof(rr.payload.imm_ass_rej.payload); i := i + 1) {
409 ra := bit2oct(rr.payload.imm_ass_rej.payload[i].req_ref.ra);
410 fn := 23; //FIXME();
411 /* lookup client based on RA+time, deliver to client */
412 cid := f_cid_by_ra_fn(ra, fn);
413 if (cid != -1) {
414 CLIENT_PT.send(rx_rsl.rsl) to ConnectionTable[cid].comp_ref;
415 /* delete ClientTable entry, as it failed */
416 f_cid_clear(cid);
417 }
418 }
419 }
420 }
Vadim Yanitskiya2c12c92020-05-25 22:08:23 +0700421 [not bts_role] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_CHAN_RQD(?))) -> value rx_rsl {
Pau Espin Pedrol6451b042018-10-24 20:36:16 +0200422 var RSL_IE_RequestRef req_ref;
423 req_ref := rx_rsl.rsl.ies[1].body.req_ref;
424 cid := f_cid_by_ra_fn2(req_ref.ra, req_ref.frame_nr);
425 if (cid != -1) {
426 CLIENT_PT.send(rx_rsl.rsl) to ConnectionTable[cid].comp_ref;
427 f_cid_clear(cid);
428 } else {
429 CCHAN_PT.send(rx_rsl);
430 }
431 }
Harald Welte714ded92017-12-08 14:00:22 +0100432
Vadim Yanitskiya2c12c92020-05-25 22:08:23 +0700433 [bts_role] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_PAGING_CMD(?, ?))) -> value rx_rsl {
Harald Welte714ded92017-12-08 14:00:22 +0100434 /* broadcast to all clients? */
435 for (i := 0; i < sizeof(ConnectionTable); i := i + 1) {
436 if (ispresent(ConnectionTable[i].comp_ref)) {
437 CLIENT_PT.send(rx_rsl.rsl) to ConnectionTable[i].comp_ref;
438 }
439 }
440 }
441
Harald Welte1c02fd12018-02-19 19:20:47 +0100442 /* Forward common channel management to the special port for it */
Vadim Yanitskiya2c12c92020-05-25 22:08:23 +0700443 [] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_MsgTypeT(?))) -> value rx_rsl {
Harald Welte1c02fd12018-02-19 19:20:47 +0100444 CCHAN_PT.send(rx_rsl);
Harald Welte714ded92017-12-08 14:00:22 +0100445 }
446
Harald Welte1c02fd12018-02-19 19:20:47 +0100447 /* Forward common channel management to the special port for it */
Vadim Yanitskiya2c12c92020-05-25 22:08:23 +0700448 [] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_MsgTypeC(?))) -> value rx_rsl {
Harald Welte1c02fd12018-02-19 19:20:47 +0100449 CCHAN_PT.send(rx_rsl);
Harald Welte714ded92017-12-08 14:00:22 +0100450 }
451
452 /* blindly acknowledge all channel activations */
Vadim Yanitskiya2c12c92020-05-25 22:08:23 +0700453 [bts_role] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_MsgTypeD(RSL_MT_CHAN_ACTIV))) -> value rx_rsl {
Harald Weltef70df652018-01-29 22:00:23 +0100454 chan_nr := rx_rsl.rsl.ies[0].body.chan_nr;
Harald Weltead2647b2018-03-22 19:53:55 +0100455 trx_nr := f_trx_by_streamId(rx_rsl.streamId);
456 f_store_last_act_data(trx_nr, chan_nr, rx_rsl.rsl);
Vadim Yanitskiy9b4e3562020-05-25 21:40:52 +0700457 IPA_PT.send(ts_ASP_RSL_UD(ts_RSL_CHAN_ACT_ACK(chan_nr, 23), rx_rsl.streamId));
Harald Welte714ded92017-12-08 14:00:22 +0100458 }
459
Vadim Yanitskiya2c12c92020-05-25 22:08:23 +0700460 [not dchan_suspended] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_MsgTypeDR(?))) -> value rx_rsl {
Harald Welte714ded92017-12-08 14:00:22 +0100461 /* dispatch to channel based on ChanId */
462 cid := f_cid_by_chan_nr(f_trx_by_streamId(rx_rsl.streamId),
463 rx_rsl.rsl.ies[0].body.chan_nr);
464 if (cid != -1) {
465 CLIENT_PT.send(rx_rsl.rsl) to ConnectionTable[cid].comp_ref;
466 } else {
467 setverdict(fail, "RSL for unknown Dchan");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200468 mtc.stop;
Harald Welte714ded92017-12-08 14:00:22 +0100469 }
470 }
471
Harald Welte70b52c92018-02-12 20:47:31 +0100472 [not dchan_suspended] IPA_PT.receive {
Harald Welte714ded92017-12-08 14:00:22 +0100473 setverdict(fail, "Received unknown primitive from IPA");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200474 mtc.stop;
Harald Welte714ded92017-12-08 14:00:22 +0100475 }
476
Harald Welte1c02fd12018-02-19 19:20:47 +0100477 [bts_role] CLIENT_PT.receive(RSLDC_ChanRqd:?) -> value chan_rqd sender vc_conn {
Harald Welte714ded92017-12-08 14:00:22 +0100478 /* Store the knowledge that this sender has requested a certain RQ+time */
479 f_cid_create(chan_rqd.ra, chan_rqd.fn, vc_conn);
Vadim Yanitskiy9b4e3562020-05-25 21:40:52 +0700480 IPA_PT.send(ts_ASP_RSL_UD(ts_RSL_CHAN_RQD(chan_rqd.ra, chan_rqd.fn)));
Harald Welte714ded92017-12-08 14:00:22 +0100481 }
482
Pau Espin Pedrol6451b042018-10-24 20:36:16 +0200483 [not bts_role] CLIENT_PT.receive(RSLDC_ChanRqd:?) -> value chan_rqd sender vc_conn {
484 /* Store the knowledge that this sender has requested a certain RQ+time */
485 f_cid_create(chan_rqd.ra, chan_rqd.fn, vc_conn);
486 }
487
Harald Welte714ded92017-12-08 14:00:22 +0100488 [] CLIENT_PT.receive(tr_RSL_MsgType(?)) -> value rx_rsl_msg sender vc_conn {
489 /* forward to BSC */
490 cid := f_cid_by_comp_ref(vc_conn);
Vadim Yanitskiy9b4e3562020-05-25 21:40:52 +0700491 IPA_PT.send(ts_ASP_RSL_UD(rx_rsl_msg, ConnectionTable[cid].stream_id));
Harald Welte714ded92017-12-08 14:00:22 +0100492 }
493
Vadim Yanitskiya2c12c92020-05-25 22:08:23 +0700494 [] CCHAN_PT.receive(tr_ASP_RSL_UD(?)) -> value rx_rsl {
Vadim Yanitskiy9b4e3562020-05-25 21:40:52 +0700495 IPA_PT.send(ts_ASP_RSL_UD(rx_rsl.rsl, rx_rsl.streamId));
Harald Welte34252c52018-02-24 04:51:50 +0100496 }
497
Harald Weltef70df652018-01-29 22:00:23 +0100498 /* explicit registration, e.g. in (non-immediate) assignment case */
499 [] RSL_PROC.getcall(RSLEM_register:{?,?,?}) -> param(trx_nr, chan_nr, vc_conn) {
500 f_cid_create_cnr(trx_nr, chan_nr, vc_conn);
Harald Weltee32ad992018-05-31 22:17:46 +0200501 RSL_PROC.reply(RSLEM_register:{trx_nr, chan_nr, vc_conn}) to vc_conn;
Harald Weltef70df652018-01-29 22:00:23 +0100502 }
503
Harald Welte1909f462018-01-29 22:29:29 +0100504 [] RSL_PROC.getcall(RSLEM_unregister:{?,?,?}) -> param(trx_nr, chan_nr, vc_conn) {
505 cid := f_cid_by_chan_nr(trx_nr, chan_nr);
506 f_cid_clear(cid);
Harald Weltee32ad992018-05-31 22:17:46 +0200507 RSL_PROC.reply(RSLEM_unregister:{trx_nr, chan_nr, vc_conn}) to vc_conn;
Harald Welte1909f462018-01-29 22:29:29 +0100508 }
509
Harald Weltee32ad992018-05-31 22:17:46 +0200510 [] RSL_PROC.getcall(RSLEM_suspend:{true}) -> sender vc_conn {
Harald Welte70b52c92018-02-12 20:47:31 +0100511 log("Suspending DChan");
512 dchan_suspended := true;
Harald Weltee32ad992018-05-31 22:17:46 +0200513 RSL_PROC.reply(RSLEM_suspend:{true}) to vc_conn;
Harald Welte70b52c92018-02-12 20:47:31 +0100514 }
515
Harald Weltee32ad992018-05-31 22:17:46 +0200516 [] RSL_PROC.getcall(RSLEM_suspend:{false}) -> sender vc_conn {
Harald Welte70b52c92018-02-12 20:47:31 +0100517 log("Resuming DChan");
518 dchan_suspended := false;
Harald Weltee32ad992018-05-31 22:17:46 +0200519 RSL_PROC.reply(RSLEM_suspend:{false}) to vc_conn;
Harald Welte70b52c92018-02-12 20:47:31 +0100520 }
Harald Welte1909f462018-01-29 22:29:29 +0100521
Harald Weltee32ad992018-05-31 22:17:46 +0200522 [] RSL_PROC.getcall(RSLEM_get_last_act:{?,?,?}) -> param(trx_nr, chan_nr) sender vc_conn {
Harald Weltead2647b2018-03-22 19:53:55 +0100523 var RSL_Message last_chan_act := f_lookup_last_act(trx_nr, chan_nr);
Harald Weltee32ad992018-05-31 22:17:46 +0200524 RSL_PROC.reply(RSLEM_get_last_act:{trx_nr, chan_nr, last_chan_act}) to vc_conn;
Harald Weltead2647b2018-03-22 19:53:55 +0100525 }
Harald Welte714ded92017-12-08 14:00:22 +0100526 }
527 }
528}
529
Daniel Willmann17f970f2018-01-17 12:03:19 +0100530private function f_conn_table_init()
531runs on RSL_Emulation_CT {
532 var integer i;
533
534 /* Initialize the ConnectionTable */
535 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
536 f_cid_clear(i);
537 }
538}
Harald Welte714ded92017-12-08 14:00:22 +0100539
Harald Weltef70df652018-01-29 22:00:23 +0100540/* client/conn_hdlr side function to use procedure port to register stream_id/chan_nr */
Harald Welte421e4d42018-02-12 20:04:50 +0100541function f_rslem_register(uint8_t trx_nr, RslChannelNr chan_nr, RSLEM_PROC_PT PT := RSL_PROC)
542runs on RSL_DchanHdlr {
543 PT.call(RSLEM_register:{trx_nr, chan_nr, self}) {
544 [] PT.getreply(RSLEM_register:{?,?,?}) {};
Harald Weltef70df652018-01-29 22:00:23 +0100545 }
546}
547
Harald Welte1909f462018-01-29 22:29:29 +0100548/* client/conn_hdlr side function to use procedure port to unregister stream_id/chan_nr */
Harald Welte421e4d42018-02-12 20:04:50 +0100549function f_rslem_unregister(uint8_t trx_nr, RslChannelNr chan_nr, RSLEM_PROC_PT PT := RSL_PROC)
550runs on RSL_DchanHdlr {
551 PT.call(RSLEM_unregister:{trx_nr, chan_nr, self}) {
552 [] PT.getreply(RSLEM_unregister:{?,?,?}) {};
Harald Welte1909f462018-01-29 22:29:29 +0100553 }
554}
555
Harald Welte70b52c92018-02-12 20:47:31 +0100556/* resume handling of RSL DChan messages from IPA until f_rslem_resume() is called */
557function f_rslem_suspend(RSLEM_PROC_PT PT)
558runs on RSL_DchanHdlr {
559 PT.call(RSLEM_suspend:{true}) {
560 [] PT.getreply(RSLEM_suspend:{true}) {};
561 }
562}
563
564/* resume handling of RSL DChan messages after f_rslem_suspend() is called */
565function f_rslem_resume(RSLEM_PROC_PT PT)
566runs on RSL_DchanHdlr {
567 PT.call(RSLEM_suspend:{false}) {
568 [] PT.getreply(RSLEM_suspend:{false}) {};
569 }
570}
571
Harald Weltead2647b2018-03-22 19:53:55 +0100572/* obtain the last RSL_CHAN_ACT message for the given chan_nr */
573function f_rslem_get_last_act(RSLEM_PROC_PT PT, uint8_t trx_nr, RslChannelNr chan_nr)
574runs on RSL_DchanHdlr return RSL_Message {
575 var RSL_Message chan_act;
576 PT.call(RSLEM_get_last_act:{trx_nr, chan_nr, -}) {
577 [] PT.getreply(RSLEM_get_last_act:{trx_nr, chan_nr, ?}) -> param(chan_act) {};
578 }
579 return chan_act;
580}
581
582
Harald Welte70b52c92018-02-12 20:47:31 +0100583
Harald Welte1909f462018-01-29 22:29:29 +0100584
Harald Welte714ded92017-12-08 14:00:22 +0100585}