blob: eeb5ed56c9a738a2279139b471aade249d3312cb [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
Vadim Yanitskiy6de2fcb2020-05-25 19:40:45 +070067type enumerated RSLEm_EventType {
68 RSLEM_EV_TRX_UP,
69 RSLEM_EV_TRX_DOWN
70};
71
72type record RSLEm_Event {
73 RSLEm_EventType ev_type,
74 IpaStreamId sid
75};
76
77template (value) RSLEm_Event ts_RSLEm_EV(RSLEm_EventType ev_type,
78 IpaStreamId sid) := {
79 ev_type := ev_type,
80 sid := sid
81};
82template RSLEm_Event tr_RSLEm_EV(template RSLEm_EventType ev_type,
83 template IpaStreamId sid := ?) := {
84 ev_type := ev_type,
85 sid := sid
86};
87
Harald Welte714ded92017-12-08 14:00:22 +010088type port RSL_DCHAN_PT message {
89 inout RSLDC_ChanRqd, RSL_Message;
90} with { extension "internal" };
91
Harald Welte1c02fd12018-02-19 19:20:47 +010092type port RSL_CCHAN_PT message {
Vadim Yanitskiy6de2fcb2020-05-25 19:40:45 +070093 inout ASP_RSL_Unitdata, RSLEm_Event;
Harald Welte1c02fd12018-02-19 19:20:47 +010094} with { extension "internal" };
95
96
Harald Weltef70df652018-01-29 22:00:23 +010097signature RSLEM_register(uint8_t trx_nr, RslChannelNr chan_nr, RSL_DchanHdlr hdlr);
Harald Welte1909f462018-01-29 22:29:29 +010098signature RSLEM_unregister(uint8_t trx_nr, RslChannelNr chan_nr, RSL_DchanHdlr hdlr);
Harald Welte70b52c92018-02-12 20:47:31 +010099signature RSLEM_suspend(boolean suspend);
Harald Weltead2647b2018-03-22 19:53:55 +0100100signature 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 +0100101
102type port RSLEM_PROC_PT procedure {
Harald Weltead2647b2018-03-22 19:53:55 +0100103 inout RSLEM_register, RSLEM_unregister, RSLEM_suspend, RSLEM_get_last_act;
Harald Weltef70df652018-01-29 22:00:23 +0100104} with { extension "internal" };
105
Harald Welte714ded92017-12-08 14:00:22 +0100106/***********************************************************************
107 * Client Component for a single dedicated channel
108 ***********************************************************************/
109
110private function f_rx_or_fail(template RSL_Message exp_rx) runs on RSL_DchanHdlr return RSL_Message
111{
112 var RSL_Message rx_rsl;
113 timer T := 10.0;
114
115 /* request a channel to be established */
116 T.start;
117 alt {
118 [] RSL.receive(exp_rx) -> value rx_rsl {
119 T.stop;
120 return rx_rsl;
121 }
122 [] RSL.receive {
123 setverdict(fail, "Unexpected RSL message on DCHAN");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200124 mtc.stop;
Harald Welte714ded92017-12-08 14:00:22 +0100125 }
126 [] T.timeout {
127 setverdict(fail, "Timeout waiting for RSL on DCHAN");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200128 mtc.stop;
Harald Welte714ded92017-12-08 14:00:22 +0100129 }
130 }
131 /* never reached */
132 return rx_rsl;
133}
134
135/* establish a dedicated channel using 'ra' */
136function f_chan_est(OCT1 ra, octetstring est_l3, template RslLinkId link_id, GsmFrameNumber fn := 23)
137runs on RSL_DchanHdlr {
138 var RSL_Message rx_rsl;
139 var GsmRrMessage rr;
140
141 /* request a channel to be established */
142 RSL.send(ts_RSLDC_ChanRqd(ra, fn));
143 /* expect immediate assignment */
144 rx_rsl := f_rx_or_fail(tr_RSL_IMM_ASSIGN);
145 rr := dec_GsmRrMessage(rx_rsl.ies[1].body.full_imm_ass_info.payload);
146 g_chan_nr := rr.payload.imm_ass.chan_desc.chan_nr;
147 RSL.send(ts_RSL_EST_IND(g_chan_nr, valueof(link_id), est_l3));
148}
149
150function f_deact_chan(RSL_Cause cause) runs on RSL_DchanHdlr
151{
152 var RSL_Message rx_rsl;
153
154 RSL.send(ts_RSL_CONN_FAIL_IND(g_chan_nr, cause));
155 rx_rsl := f_rx_or_fail(tr_RSL_MsgTypeD(RSL_MT_RF_CHAN_REL));
156 /* FIXME RSL.send(ts_RSL_RF_CHAN_REL_ACK()) */
157}
158
159
160
161/***********************************************************************
162 * Main Component
163 ***********************************************************************/
164
165private type record ConnectionData {
166 /* component reference to the client component */
167 RSL_DchanHdlr comp_ref,
168 /* RSL (dedicated) Channel number we're handling */
169 uint8_t trx_nr optional,
170 IpaStreamId stream_id optional,
171 RslChannelNr chan_nr optional,
172 /* Random Reference */
173 OCT1 ra optional,
174 GsmFrameNumber ra_fn optional
175};
176
177private function f_cid_by_comp_ref(RSL_DchanHdlr comp_ref)
178runs on RSL_Emulation_CT return integer {
179 var integer i;
180 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
181 if (ispresent(ConnectionTable[i].comp_ref) and
182 ConnectionTable[i].comp_ref == comp_ref) {
183 return i;
184 }
185 }
186 log("No Dchan handler for ", comp_ref);
187 return -1;
188}
189
190private function f_cid_by_chan_nr(uint8_t trx_nr, RslChannelNr chan_nr)
191runs on RSL_Emulation_CT return integer {
192 var integer i;
193 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
194 if (ispresent(ConnectionTable[i].chan_nr) and
195 ConnectionTable[i].chan_nr == chan_nr and ConnectionTable[i].trx_nr == trx_nr) {
196 return i;
197 }
198 }
199 log("No Dchan handler for ", trx_nr, chan_nr);
200 return -1;
201}
202
203private function f_cid_by_ra_fn(OCT1 ra, GsmFrameNumber fn)
204runs on RSL_Emulation_CT return integer {
205 var integer i;
206 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
207 if (ispresent(ConnectionTable[i].ra) and
208 ConnectionTable[i].ra == ra and ConnectionTable[i].ra_fn == fn) {
209 return i;
210 }
211 }
212 log("No Dchan handler for ", ra, fn);
213 return -1;
214}
215
Pau Espin Pedrol6451b042018-10-24 20:36:16 +0200216/* Matches by only RA if FN is ommited in one of the connections allocated */
217private function f_cid_by_ra_fn2(OCT1 ra, RSL_IE_FrameNumber fn)
218runs on RSL_Emulation_CT return integer {
219 var integer i;
220 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
221 if (ispresent(ConnectionTable[i].ra) and
222 ConnectionTable[i].ra == ra) {
223 if (not ispresent(ConnectionTable[i].ra_fn) or
224 fn == valueof(ts_RSL_IE_FrameNumber(ConnectionTable[i].ra_fn))) {
225 return i;
226 }
227 }
228 }
229 log("No Dchan handler for ", ra, fn);
230 return -1;
231}
232
Harald Welte714ded92017-12-08 14:00:22 +0100233/* create an ew client with given RA and FN */
Pau Espin Pedrol6451b042018-10-24 20:36:16 +0200234private function f_cid_create(OCT1 ra, template (omit) GsmFrameNumber fn, RSL_DchanHdlr comp_ref)
Harald Welte930d0a72018-03-22 22:08:40 +0100235runs on RSL_Emulation_CT {
Harald Welte714ded92017-12-08 14:00:22 +0100236 var integer i;
237 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
Harald Weltef70df652018-01-29 22:00:23 +0100238 if (not ispresent(ConnectionTable[i].ra) and
239 not ispresent(ConnectionTable[i].trx_nr)) {
Harald Welte714ded92017-12-08 14:00:22 +0100240 ConnectionTable[i].ra := ra;
Pau Espin Pedrol6451b042018-10-24 20:36:16 +0200241 if (ispresent(fn)) {
242 ConnectionTable[i].ra_fn := valueof(fn);
243 } else {
244 ConnectionTable[i].ra_fn := omit;
245 }
Harald Welte714ded92017-12-08 14:00:22 +0100246 ConnectionTable[i].comp_ref := comp_ref;
Harald Welte930d0a72018-03-22 22:08:40 +0100247 return;
Harald Welte714ded92017-12-08 14:00:22 +0100248 }
249 }
Daniel Willmann8273fb92018-07-05 17:31:20 +0200250 testcase.stop("No free entry in conn table for ", ra, fn);
Harald Welte714ded92017-12-08 14:00:22 +0100251}
252
Vadim Yanitskiyefc94132020-05-24 04:26:45 +0700253/* create a new client with given RA and FN */
Harald Weltef70df652018-01-29 22:00:23 +0100254private function f_cid_create_cnr(uint8_t trx_nr, RslChannelNr chan_nr, RSL_DchanHdlr comp_ref)
Harald Welte930d0a72018-03-22 22:08:40 +0100255runs on RSL_Emulation_CT {
Harald Weltef70df652018-01-29 22:00:23 +0100256 var integer i;
257 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
258 if (not ispresent(ConnectionTable[i].ra) and
259 not ispresent(ConnectionTable[i].trx_nr)) {
260 ConnectionTable[i].stream_id := f_streamId_by_trx(trx_nr);
261 ConnectionTable[i].trx_nr := trx_nr;
262 ConnectionTable[i].chan_nr := chan_nr;
263 ConnectionTable[i].comp_ref := comp_ref;
Harald Welte930d0a72018-03-22 22:08:40 +0100264 return;
Harald Weltef70df652018-01-29 22:00:23 +0100265 }
266 }
Daniel Willmann8273fb92018-07-05 17:31:20 +0200267 testcase.stop("No free entry in conn table for ", trx_nr, chan_nr, comp_ref);
Harald Weltef70df652018-01-29 22:00:23 +0100268}
269
270
Vadim Yanitskiyefc94132020-05-24 04:26:45 +0700271/* delete client with given RA and FN */
Harald Weltef70df652018-01-29 22:00:23 +0100272private function f_cid_delete_cnr(IpaStreamId stream_id, RslChannelNr chan_nr, RSL_DchanHdlr comp_ref)
273runs on RSL_Emulation_CT return integer {
274 var integer i;
275 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
276 if (ConnectionTable[i].comp_ref == null) {
277 continue;
278 }
279 if (ConnectionTable[i].stream_id == stream_id and
280 ConnectionTable[i].chan_nr == chan_nr and
281 ConnectionTable[i].comp_ref == comp_ref) {
282 f_cid_clear(i);
283 }
284 }
285 log("Unable to find entry to delete for ", stream_id, chan_nr, comp_ref);
286 return -1;
287}
288
289
Harald Welte714ded92017-12-08 14:00:22 +0100290private function f_cid_clear(integer cid)
291runs on RSL_Emulation_CT {
292 ConnectionTable[cid].ra := omit;
293 ConnectionTable[cid].ra_fn := omit;
Harald Welte714ded92017-12-08 14:00:22 +0100294 ConnectionTable[cid].trx_nr := omit;
295 ConnectionTable[cid].stream_id := omit;
296 ConnectionTable[cid].chan_nr := omit;
Harald Weltef70df652018-01-29 22:00:23 +0100297 ConnectionTable[cid].comp_ref := null;
Harald Welte714ded92017-12-08 14:00:22 +0100298}
299
Harald Weltead2647b2018-03-22 19:53:55 +0100300/* last activation for a given channel number */
301type record LastActData {
302 uint8_t trx_nr optional,
303 RslChannelNr chan_nr optional,
304 RSL_Message chan_act optional
305}
306
307private function f_store_last_act_data(uint8_t trx_nr, RslChannelNr chan_nr, RSL_Message chan_act)
308runs on RSL_Emulation_CT {
309 for (var integer i := 0; i < sizeof(LastActTable); i := i+1) {
310 if (not ispresent(LastActTable[i].chan_nr) or
311 (LastActTable[i].chan_nr == chan_nr and LastActTable[i].trx_nr == trx_nr)) {
312 LastActTable[i].trx_nr := trx_nr;
313 LastActTable[i].chan_nr := chan_nr;
314 LastActTable[i].chan_act := chan_act;
315 return;
316 }
317 }
Daniel Willmann8273fb92018-07-05 17:31:20 +0200318 testcase.stop("No space left in LastActTable to store chan_act for ", chan_nr);
Harald Weltead2647b2018-03-22 19:53:55 +0100319}
320
321private function f_lookup_last_act(uint8_t trx_nr, RslChannelNr chan_nr)
322runs on RSL_Emulation_CT return RSL_Message {
323 for (var integer i := 0; i < sizeof(LastActTable); i := i+1) {
324 if (ispresent(LastActTable[i].chan_nr) and LastActTable[i].chan_nr == chan_nr
325 and LastActTable[i].trx_nr == trx_nr) {
326 return LastActTable[i].chan_act;
327 }
328 }
Daniel Willmann8273fb92018-07-05 17:31:20 +0200329 testcase.stop("No LastActTable entry found for TRX ", trx_nr, " ", chan_nr);
Harald Weltead2647b2018-03-22 19:53:55 +0100330}
331
332private function f_last_act_table_init() runs on RSL_Emulation_CT {
333 for (var integer i := 0; i < sizeof(LastActTable); i := i+1) {
334 LastActTable[i] := { omit, omit, omit };
335 }
336}
337
Vadim Yanitskiy6de2fcb2020-05-25 19:40:45 +0700338private function f_trx_conn_map_init()
339runs on RSL_Emulation_CT {
340 for (var integer i := 0; i < sizeof(TrxConnMap); i := i + 1) {
341 TrxConnMap[i] := -1;
342 }
343}
344
345private function f_trx_conn_map_register(integer conn_id, in IpaCcmIdResp id_resp)
346runs on RSL_Emulation_CT return IpaStreamId {
347 var template charstring unit_id_fmt := pattern "(\d+)/(\d+)/(\d+)";
348 var charstring unit_id;
349 var integer trx_nr;
350 var integer idx;
351
352 /* Check if we have room for a new connection */
353 if (TrxConnNum >= sizeof(TrxConnMap)) {
354 testcase.stop("We cannot handle more than ", sizeof(TrxConnMap), " transceivers");
355 }
356
357 /* Find IPAC_IDTAG_UNITID in the IPA IDENTITY RESPONSE */
358 idx := f_ipa_id_resp_find_ie(id_resp, IPAC_IDTAG_UNITID);
359 if (idx < 0) {
360 testcase.stop("IPA IDENTITY RESPONSE contains no unit-id");
361 }
362
363 /* Make sure that IPA unit-id is valid */
364 unit_id := oct2char(id_resp[idx].data);
365 if (not match(unit_id, unit_id_fmt)) {
366 testcase.stop("IPA unit-id has unknown/unexpected format");
367 }
368
369 /* Parse transceiver number (site/bts/trx).
370 * TODO: implement and use declaratice types. */
371 unit_id := regexp(unit_id, unit_id_fmt, 2);
372 trx_nr := str2int(unit_id);
373
374 if (trx_nr >= sizeof(TrxConnMap)) {
375 testcase.stop("Transceiver #", trx_nr, " does not fit");
376 } else if (TrxConnMap[trx_nr] != -1) {
377 testcase.stop("Transceiver #", trx_nr, " is already connected?!?");
378 }
379
380 /* Finally, store the connection ID */
381 log("Mapped TRX#", trx_nr, " to TCP/IP conn_id=", conn_id);
382 TrxConnMap[trx_nr] := conn_id;
383 TrxConnNum := TrxConnNum + 1;
384
385 return f_streamId_by_trx(trx_nr);
386}
387
388private function f_trx_conn_map_resolve(IpaStreamId id)
389runs on RSL_Emulation_CT return integer {
390 var integer trx_nr := f_trx_by_streamId(id);
391
392 if (TrxConnMap[trx_nr] == -1) {
393 testcase.stop("Transceiver #", trx_nr, " is not connected");
394 }
395
396 return TrxConnMap[trx_nr];
397}
398
Harald Welte714ded92017-12-08 14:00:22 +0100399type component RSL_Emulation_CT {
400 /* port facing down towards IPA emulation */
401 port IPA_RSL_PT IPA_PT;
402 /* port facing up towards dedicated channel handler */
403 port RSL_DCHAN_PT CLIENT_PT;
Harald Weltef70df652018-01-29 22:00:23 +0100404 port RSLEM_PROC_PT RSL_PROC;
Harald Welte714ded92017-12-08 14:00:22 +0100405
Harald Welte1c02fd12018-02-19 19:20:47 +0100406 /* port for Common Channel / TRX Management */
407 port RSL_CCHAN_PT CCHAN_PT;
408
Harald Welte714ded92017-12-08 14:00:22 +0100409 /* state of all concurrent connections / dedicated channels */
410 var ConnectionData ConnectionTable[64];
Harald Weltead2647b2018-03-22 19:53:55 +0100411
412 /* last RSL CHAN ACT for each chan_nr */
413 var LastActData LastActTable[64];
Vadim Yanitskiy6de2fcb2020-05-25 19:40:45 +0700414
415 /* IPA stream ID -> TCP/IP connection ID mapping for transceivers */
416 var integer TrxConnNum := 0; /* number of connected transceivers */
417 var integer TrxConnMap[4]; /* up to 4 transceivers for now */
Harald Welte714ded92017-12-08 14:00:22 +0100418}
419
420
Harald Welte714ded92017-12-08 14:00:22 +0100421private function f_trx_by_streamId(IpaStreamId id) return integer {
422 return enum2int(id);
423}
424
Harald Weltef70df652018-01-29 22:00:23 +0100425private function f_streamId_by_trx(uint8_t trx_nr) return IpaStreamId {
426 select (trx_nr) {
427 case (0) { return IPAC_PROTO_RSL_TRX0; }
428 case (1) { return IPAC_PROTO_RSL_TRX1; }
429 case (2) { return IPAC_PROTO_RSL_TRX2; }
430 case (3) { return IPAC_PROTO_RSL_TRX3; }
431 }
Daniel Willmanna6ea2ef2018-07-24 09:55:52 +0200432 setverdict(fail, "Unknown stream ID ", trx_nr);
433 mtc.stop;
Harald Weltef70df652018-01-29 22:00:23 +0100434}
435
Harald Welte714ded92017-12-08 14:00:22 +0100436
Harald Welte1c02fd12018-02-19 19:20:47 +0100437function main(boolean bts_role := true) runs on RSL_Emulation_CT {
Harald Weltebb6aed32018-02-21 12:19:18 +0100438 var ASP_IPA_Event evt;
Harald Welte714ded92017-12-08 14:00:22 +0100439 var ASP_RSL_Unitdata rx_rsl;
440 var RSL_Message rx_rsl_msg;
441 var RSLDC_ChanRqd chan_rqd;
442 var RSL_DchanHdlr vc_conn;
Harald Weltef70df652018-01-29 22:00:23 +0100443 var RslChannelNr chan_nr;
444 var uint8_t trx_nr;
Vadim Yanitskiy6de2fcb2020-05-25 19:40:45 +0700445 var integer conn_id;
Harald Welte714ded92017-12-08 14:00:22 +0100446 var integer cid;
447 var integer i;
Harald Welte70b52c92018-02-12 20:47:31 +0100448 /* special synchronization handling during hand-over */
449 var boolean dchan_suspended := false;
Harald Welte714ded92017-12-08 14:00:22 +0100450
Daniel Willmann17f970f2018-01-17 12:03:19 +0100451 f_conn_table_init();
Vadim Yanitskiy6de2fcb2020-05-25 19:40:45 +0700452 f_trx_conn_map_init();
Harald Weltead2647b2018-03-22 19:53:55 +0100453 f_last_act_table_init();
Daniel Willmann17f970f2018-01-17 12:03:19 +0100454
Harald Welte714ded92017-12-08 14:00:22 +0100455 while (true) {
456 alt {
Vadim Yanitskiya2afacc2020-05-18 21:16:19 +0700457 [bts_role] IPA_PT.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_UP)) {
Harald Weltebb6aed32018-02-21 12:19:18 +0100458 }
Vadim Yanitskiya2afacc2020-05-18 21:16:19 +0700459 [not bts_role] IPA_PT.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_UP)) -> value evt {
Vadim Yanitskiy6de2fcb2020-05-25 19:40:45 +0700460 log("A new IPA/RSL connection has been established (conn_id=",
461 evt.conn_id, "), waiting for IDENTITY RESPONSE...");
462 }
463 [not bts_role] IPA_PT.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_ID_RESP)) -> value evt {
464 log("Got IDENTITY RESPONSE (conn_id=", evt.conn_id, "): ", evt.id_resp);
465 /* Update [ IPA stream ID -> TCP/IP connection ID ] mapping */
466 var IpaStreamId sid := f_trx_conn_map_register(evt.conn_id, evt.id_resp);
467 /* Notify the upper layers about a new connection */
468 CCHAN_PT.send(ts_RSLEm_EV(RSLEM_EV_TRX_UP, sid));
Harald Welte624f9632017-12-16 19:26:04 +0100469 }
Vadim Yanitskiya2afacc2020-05-18 21:16:19 +0700470 [bts_role] IPA_PT.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_DOWN)) {
Pau Espin Pedrola07cfd92018-10-22 15:54:41 +0200471 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Lost IPA connection!");
472
473 }
Vadim Yanitskiya2afacc2020-05-18 21:16:19 +0700474 [not bts_role] IPA_PT.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_DOWN)) {
Pau Espin Pedrola07cfd92018-10-22 15:54:41 +0200475 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Lost IPA connection!");
476 }
Vadim Yanitskiya2afacc2020-05-18 21:16:19 +0700477 [bts_role] IPA_PT.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_ID_ACK)) {
Vadim Yanitskiy9b4e3562020-05-25 21:40:52 +0700478 IPA_PT.send(ts_ASP_RSL_UD(ts_RSL_PAGING_LOAD_IND(23)));
Harald Welte714ded92017-12-08 14:00:22 +0100479 }
Vadim Yanitskiya2afacc2020-05-18 21:16:19 +0700480 [not bts_role] IPA_PT.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_ID_ACK)) { }
Vadim Yanitskiya60e5cf2020-05-26 01:46:31 +0700481 [bts_role] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_IMM_ASSIGN, sid := ?)) -> value rx_rsl {
Harald Welte714ded92017-12-08 14:00:22 +0100482 var GsmRrMessage rr;
483 var OCT1 ra;
484 var GsmFrameNumber fn;
Harald Welte714ded92017-12-08 14:00:22 +0100485 rr := dec_GsmRrMessage(rx_rsl.rsl.ies[1].body.full_imm_ass_info.payload);
486 if (ischosen(rr.payload.imm_ass)) {
487 ra := bit2oct(rr.payload.imm_ass.req_ref.ra);
488 fn := 23; //FIXME(rr.payload.imm_ass);
489 /* lookup client based on RA+time, deliver to client */
490 cid := f_cid_by_ra_fn(ra, fn);
491 if (cid == -1) {
492 setverdict(fail, "IMM ASS for unknown DChan");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200493 mtc.stop;
Harald Welte714ded92017-12-08 14:00:22 +0100494 }
495 /* update client with trx_nr */
496 ConnectionTable[cid].trx_nr := f_trx_by_streamId(rx_rsl.streamId);
497 ConnectionTable[cid].stream_id := rx_rsl.streamId;
498 /* update client with chan_nr */
499 ConnectionTable[cid].chan_nr := rr.payload.imm_ass.chan_desc.chan_nr;
500 /* TODO: add timer to time-out ConnectionTable entries which
501 * never get followed-up to */
502 CLIENT_PT.send(rx_rsl.rsl) to ConnectionTable[cid].comp_ref;
503 } else if (ischosen(rr.payload.imm_ass_rej)) {
504 for (i := 0; i < sizeof(rr.payload.imm_ass_rej.payload); i := i + 1) {
505 ra := bit2oct(rr.payload.imm_ass_rej.payload[i].req_ref.ra);
506 fn := 23; //FIXME();
507 /* lookup client based on RA+time, deliver to client */
508 cid := f_cid_by_ra_fn(ra, fn);
509 if (cid != -1) {
510 CLIENT_PT.send(rx_rsl.rsl) to ConnectionTable[cid].comp_ref;
511 /* delete ClientTable entry, as it failed */
512 f_cid_clear(cid);
513 }
514 }
515 }
516 }
Vadim Yanitskiya60e5cf2020-05-26 01:46:31 +0700517 [not bts_role] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_CHAN_RQD(?), sid := ?)) -> value rx_rsl {
Pau Espin Pedrol6451b042018-10-24 20:36:16 +0200518 var RSL_IE_RequestRef req_ref;
519 req_ref := rx_rsl.rsl.ies[1].body.req_ref;
520 cid := f_cid_by_ra_fn2(req_ref.ra, req_ref.frame_nr);
521 if (cid != -1) {
522 CLIENT_PT.send(rx_rsl.rsl) to ConnectionTable[cid].comp_ref;
523 f_cid_clear(cid);
524 } else {
525 CCHAN_PT.send(rx_rsl);
526 }
527 }
Harald Welte714ded92017-12-08 14:00:22 +0100528
Vadim Yanitskiya60e5cf2020-05-26 01:46:31 +0700529 [bts_role] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_PAGING_CMD(?, ?), sid := ?)) -> value rx_rsl {
Harald Welte714ded92017-12-08 14:00:22 +0100530 /* broadcast to all clients? */
531 for (i := 0; i < sizeof(ConnectionTable); i := i + 1) {
532 if (ispresent(ConnectionTable[i].comp_ref)) {
533 CLIENT_PT.send(rx_rsl.rsl) to ConnectionTable[i].comp_ref;
534 }
535 }
536 }
537
Harald Welte1c02fd12018-02-19 19:20:47 +0100538 /* Forward common channel management to the special port for it */
Vadim Yanitskiya60e5cf2020-05-26 01:46:31 +0700539 [] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_MsgTypeT(?), sid := ?)) -> value rx_rsl {
Harald Welte1c02fd12018-02-19 19:20:47 +0100540 CCHAN_PT.send(rx_rsl);
Harald Welte714ded92017-12-08 14:00:22 +0100541 }
542
Harald Welte1c02fd12018-02-19 19:20:47 +0100543 /* Forward common channel management to the special port for it */
Vadim Yanitskiya60e5cf2020-05-26 01:46:31 +0700544 [] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_MsgTypeC(?), sid := ?)) -> value rx_rsl {
Harald Welte1c02fd12018-02-19 19:20:47 +0100545 CCHAN_PT.send(rx_rsl);
Harald Welte714ded92017-12-08 14:00:22 +0100546 }
547
548 /* blindly acknowledge all channel activations */
Vadim Yanitskiya60e5cf2020-05-26 01:46:31 +0700549 [bts_role] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_MsgTypeD(RSL_MT_CHAN_ACTIV), sid := ?)) -> value rx_rsl {
Harald Weltef70df652018-01-29 22:00:23 +0100550 chan_nr := rx_rsl.rsl.ies[0].body.chan_nr;
Harald Weltead2647b2018-03-22 19:53:55 +0100551 trx_nr := f_trx_by_streamId(rx_rsl.streamId);
552 f_store_last_act_data(trx_nr, chan_nr, rx_rsl.rsl);
Vadim Yanitskiy9b4e3562020-05-25 21:40:52 +0700553 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 +0100554 }
555
Vadim Yanitskiya60e5cf2020-05-26 01:46:31 +0700556 [not dchan_suspended] IPA_PT.receive(tr_ASP_RSL_UD(tr_RSL_MsgTypeDR(?), sid := ?)) -> value rx_rsl {
Harald Welte714ded92017-12-08 14:00:22 +0100557 /* dispatch to channel based on ChanId */
558 cid := f_cid_by_chan_nr(f_trx_by_streamId(rx_rsl.streamId),
559 rx_rsl.rsl.ies[0].body.chan_nr);
560 if (cid != -1) {
561 CLIENT_PT.send(rx_rsl.rsl) to ConnectionTable[cid].comp_ref;
562 } else {
563 setverdict(fail, "RSL for unknown Dchan");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200564 mtc.stop;
Harald Welte714ded92017-12-08 14:00:22 +0100565 }
566 }
567
Harald Welte70b52c92018-02-12 20:47:31 +0100568 [not dchan_suspended] IPA_PT.receive {
Harald Welte714ded92017-12-08 14:00:22 +0100569 setverdict(fail, "Received unknown primitive from IPA");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200570 mtc.stop;
Harald Welte714ded92017-12-08 14:00:22 +0100571 }
572
Harald Welte1c02fd12018-02-19 19:20:47 +0100573 [bts_role] CLIENT_PT.receive(RSLDC_ChanRqd:?) -> value chan_rqd sender vc_conn {
Harald Welte714ded92017-12-08 14:00:22 +0100574 /* Store the knowledge that this sender has requested a certain RQ+time */
575 f_cid_create(chan_rqd.ra, chan_rqd.fn, vc_conn);
Vadim Yanitskiy9b4e3562020-05-25 21:40:52 +0700576 IPA_PT.send(ts_ASP_RSL_UD(ts_RSL_CHAN_RQD(chan_rqd.ra, chan_rqd.fn)));
Harald Welte714ded92017-12-08 14:00:22 +0100577 }
578
Pau Espin Pedrol6451b042018-10-24 20:36:16 +0200579 [not bts_role] CLIENT_PT.receive(RSLDC_ChanRqd:?) -> value chan_rqd sender vc_conn {
580 /* Store the knowledge that this sender has requested a certain RQ+time */
581 f_cid_create(chan_rqd.ra, chan_rqd.fn, vc_conn);
582 }
583
Vadim Yanitskiy6de2fcb2020-05-25 19:40:45 +0700584 /* RSL message from a component that runs on RSL_DchanHdlr */
585 [bts_role] CLIENT_PT.receive(tr_RSL_MsgType(?)) -> value rx_rsl_msg sender vc_conn {
Harald Welte714ded92017-12-08 14:00:22 +0100586 cid := f_cid_by_comp_ref(vc_conn);
Vadim Yanitskiy9b4e3562020-05-25 21:40:52 +0700587 IPA_PT.send(ts_ASP_RSL_UD(rx_rsl_msg, ConnectionTable[cid].stream_id));
Harald Welte714ded92017-12-08 14:00:22 +0100588 }
Vadim Yanitskiy6de2fcb2020-05-25 19:40:45 +0700589 [not bts_role] CLIENT_PT.receive(tr_RSL_MsgType(?)) -> value rx_rsl_msg sender vc_conn {
590 cid := f_cid_by_comp_ref(vc_conn);
591 conn_id := f_trx_conn_map_resolve(ConnectionTable[cid].stream_id);
592 IPA_PT.send(ts_ASP_RSL_UD(rx_rsl_msg, ConnectionTable[cid].stream_id, conn_id));
593 }
Harald Welte714ded92017-12-08 14:00:22 +0100594
Vadim Yanitskiy6de2fcb2020-05-25 19:40:45 +0700595 /* RSL message from MTC */
596 [bts_role] CCHAN_PT.receive(tr_ASP_RSL_UD(?, sid := ?)) -> value rx_rsl {
Vadim Yanitskiy9b4e3562020-05-25 21:40:52 +0700597 IPA_PT.send(ts_ASP_RSL_UD(rx_rsl.rsl, rx_rsl.streamId));
Harald Welte34252c52018-02-24 04:51:50 +0100598 }
Vadim Yanitskiy6de2fcb2020-05-25 19:40:45 +0700599 [not bts_role] CCHAN_PT.receive(tr_ASP_RSL_UD(?, sid := ?)) -> value rx_rsl {
600 conn_id := f_trx_conn_map_resolve(rx_rsl.streamId);
601 IPA_PT.send(ts_ASP_RSL_UD(rx_rsl.rsl, rx_rsl.streamId, conn_id));
602 }
Harald Welte34252c52018-02-24 04:51:50 +0100603
Harald Weltef70df652018-01-29 22:00:23 +0100604 /* explicit registration, e.g. in (non-immediate) assignment case */
605 [] RSL_PROC.getcall(RSLEM_register:{?,?,?}) -> param(trx_nr, chan_nr, vc_conn) {
606 f_cid_create_cnr(trx_nr, chan_nr, vc_conn);
Harald Weltee32ad992018-05-31 22:17:46 +0200607 RSL_PROC.reply(RSLEM_register:{trx_nr, chan_nr, vc_conn}) to vc_conn;
Harald Weltef70df652018-01-29 22:00:23 +0100608 }
609
Harald Welte1909f462018-01-29 22:29:29 +0100610 [] RSL_PROC.getcall(RSLEM_unregister:{?,?,?}) -> param(trx_nr, chan_nr, vc_conn) {
611 cid := f_cid_by_chan_nr(trx_nr, chan_nr);
612 f_cid_clear(cid);
Harald Weltee32ad992018-05-31 22:17:46 +0200613 RSL_PROC.reply(RSLEM_unregister:{trx_nr, chan_nr, vc_conn}) to vc_conn;
Harald Welte1909f462018-01-29 22:29:29 +0100614 }
615
Harald Weltee32ad992018-05-31 22:17:46 +0200616 [] RSL_PROC.getcall(RSLEM_suspend:{true}) -> sender vc_conn {
Harald Welte70b52c92018-02-12 20:47:31 +0100617 log("Suspending DChan");
618 dchan_suspended := true;
Harald Weltee32ad992018-05-31 22:17:46 +0200619 RSL_PROC.reply(RSLEM_suspend:{true}) to vc_conn;
Harald Welte70b52c92018-02-12 20:47:31 +0100620 }
621
Harald Weltee32ad992018-05-31 22:17:46 +0200622 [] RSL_PROC.getcall(RSLEM_suspend:{false}) -> sender vc_conn {
Harald Welte70b52c92018-02-12 20:47:31 +0100623 log("Resuming DChan");
624 dchan_suspended := false;
Harald Weltee32ad992018-05-31 22:17:46 +0200625 RSL_PROC.reply(RSLEM_suspend:{false}) to vc_conn;
Harald Welte70b52c92018-02-12 20:47:31 +0100626 }
Harald Welte1909f462018-01-29 22:29:29 +0100627
Harald Weltee32ad992018-05-31 22:17:46 +0200628 [] RSL_PROC.getcall(RSLEM_get_last_act:{?,?,?}) -> param(trx_nr, chan_nr) sender vc_conn {
Harald Weltead2647b2018-03-22 19:53:55 +0100629 var RSL_Message last_chan_act := f_lookup_last_act(trx_nr, chan_nr);
Harald Weltee32ad992018-05-31 22:17:46 +0200630 RSL_PROC.reply(RSLEM_get_last_act:{trx_nr, chan_nr, last_chan_act}) to vc_conn;
Harald Weltead2647b2018-03-22 19:53:55 +0100631 }
Harald Welte714ded92017-12-08 14:00:22 +0100632 }
633 }
634}
635
Daniel Willmann17f970f2018-01-17 12:03:19 +0100636private function f_conn_table_init()
637runs on RSL_Emulation_CT {
638 var integer i;
639
640 /* Initialize the ConnectionTable */
641 for (i := 0; i < sizeof(ConnectionTable); i := i+1) {
642 f_cid_clear(i);
643 }
644}
Harald Welte714ded92017-12-08 14:00:22 +0100645
Harald Weltef70df652018-01-29 22:00:23 +0100646/* client/conn_hdlr side function to use procedure port to register stream_id/chan_nr */
Harald Welte421e4d42018-02-12 20:04:50 +0100647function f_rslem_register(uint8_t trx_nr, RslChannelNr chan_nr, RSLEM_PROC_PT PT := RSL_PROC)
648runs on RSL_DchanHdlr {
649 PT.call(RSLEM_register:{trx_nr, chan_nr, self}) {
650 [] PT.getreply(RSLEM_register:{?,?,?}) {};
Harald Weltef70df652018-01-29 22:00:23 +0100651 }
652}
653
Harald Welte1909f462018-01-29 22:29:29 +0100654/* client/conn_hdlr side function to use procedure port to unregister stream_id/chan_nr */
Harald Welte421e4d42018-02-12 20:04:50 +0100655function f_rslem_unregister(uint8_t trx_nr, RslChannelNr chan_nr, RSLEM_PROC_PT PT := RSL_PROC)
656runs on RSL_DchanHdlr {
657 PT.call(RSLEM_unregister:{trx_nr, chan_nr, self}) {
658 [] PT.getreply(RSLEM_unregister:{?,?,?}) {};
Harald Welte1909f462018-01-29 22:29:29 +0100659 }
660}
661
Harald Welte70b52c92018-02-12 20:47:31 +0100662/* resume handling of RSL DChan messages from IPA until f_rslem_resume() is called */
663function f_rslem_suspend(RSLEM_PROC_PT PT)
664runs on RSL_DchanHdlr {
665 PT.call(RSLEM_suspend:{true}) {
666 [] PT.getreply(RSLEM_suspend:{true}) {};
667 }
668}
669
670/* resume handling of RSL DChan messages after f_rslem_suspend() is called */
671function f_rslem_resume(RSLEM_PROC_PT PT)
672runs on RSL_DchanHdlr {
673 PT.call(RSLEM_suspend:{false}) {
674 [] PT.getreply(RSLEM_suspend:{false}) {};
675 }
676}
677
Harald Weltead2647b2018-03-22 19:53:55 +0100678/* obtain the last RSL_CHAN_ACT message for the given chan_nr */
679function f_rslem_get_last_act(RSLEM_PROC_PT PT, uint8_t trx_nr, RslChannelNr chan_nr)
680runs on RSL_DchanHdlr return RSL_Message {
681 var RSL_Message chan_act;
682 PT.call(RSLEM_get_last_act:{trx_nr, chan_nr, -}) {
683 [] PT.getreply(RSLEM_get_last_act:{trx_nr, chan_nr, ?}) -> param(chan_act) {};
684 }
685 return chan_act;
686}
687
688
Harald Welte70b52c92018-02-12 20:47:31 +0100689
Harald Welte1909f462018-01-29 22:29:29 +0100690
Harald Welte714ded92017-12-08 14:00:22 +0100691}