Newer
Older
* @version $URL$
* $Id$
* @desc Module containing common functions for ITS SREMM SSEM
* @copyright ETSI Copyright Notification
* No part may be reproduced except as authorized by written permission.
* The copyright and the foregoing restriction extend to reproduction in all media.
* All rights reserved.
*
*/
module LibItsSremSsem_Functions {
// LibCommon
import from LibCommon_Sync all;
import from LibCommon_Time all;
import from LibCommon_VerdictControl all;
// LibIts
import from ITS_Container language "ASN.1:1997" all;
import from DSRC language "ASN.1:1997" all;
// LibItsCommon
import from LibItsCommon_TypesAndValues all;
import from LibItsCommon_Templates all;
import from LibItsCommon_Functions all;
import from LibItsCommon_Pixits all;
// LibItsSremSsem
import from LibItsSremSsem_TestSystem all;
import from LibItsSremSsem_TypesAndValues all;
import from LibItsSremSsem_Templates all;
import from LibItsSremSsem_Pics all;
import from LibItsSremSsem_Pixits all;
group utFuntions {
/**
* @desc Requests to bring the IUT in an initial state
* @param p_init The initialisation to trigger.
*/
function f_utInitializeIut(template (value) UtInitialize p_init) runs on ItsSremSsem {
utPort.send(p_init);
tc_wait.start;
alt {
[] utPort.receive(UtInitializeResult:true) {
tc_wait.stop;
log("*** " & testcasename() & ": INFO: IUT initialized ***");
}
[] tc_wait.timeout {
log("*** " & testcasename() & ": INFO: Could not receive expected UT message from IUT in time ***");
f_selfOrClientSyncAndVerdict("error", e_timeout);
}
[else] { // Shortcut defaults
//f_sleep(0.050); // 50 ms
repeat;
}
}
}
/**
* @desc Triggers an event from the application layer
* @param p_event The event to trigger.
*/
function f_utTriggerEvent(
utPort.send ( p_event );
tc_wait.start;
alt {
[] utPort.receive ( UtSremTriggerResult:? ) -> value v_result {
f_selfOrClientSyncAndVerdict("SREM Trigger failed", e_error);
}
}
[] tc_wait.timeout {
log("*** " & testcasename() & ": INFO: Could not receive expected UT message from IUT in time ***");
f_selfOrClientSyncAndVerdict("error", e_timeout);
}
[else] { // Shortcut defaults
//f_sleep(0.050); // 50 ms
repeat;
}
}
return;
}
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/**
* @desc Updates an event from the application layer
* @param p_event The event to trigger.
*/
function f_utUpdateEvent(
in template (value) UtSremUpdate p_event
) runs on ItsSremSsem {
var UtSremUpdateResult v_result;
utPort.send ( p_event );
tc_wait.start;
alt {
[] utPort.receive ( UtSremUpdateResult:? ) -> value v_result {
tc_wait.stop;
if ( not v_result ) {
f_selfOrClientSyncAndVerdict("SREM Update failed", e_error);
}
}
[] tc_wait.timeout {
log("*** " & testcasename() & ": INFO: Could not receive expected UT message from IUT in time ***");
f_selfOrClientSyncAndVerdict("error", e_timeout);
}
[else] { // Shortcut defaults
//f_sleep(0.050); // 50 ms
repeat;
}
}
return;
}
group adapterControl {
/**
* @desc Initialise secure mode if required
*/
function f_initialiseSecuredMode(
in charstring p_certificateId := PX_CERT_FOR_TS
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
) runs on ItsSremSsem {
if (PICS_IS_IUT_SECURED == true) {
if(e_success != f_acTriggerSecEvent(m_acEnableSecurity(p_certificateId))) {
log("*** INFO: TEST CASE NOW STOPPING ITSELF! ***");
stop;
}
}
} // End of function f_initialiseSecuredMode()
function f_uninitialiseSecuredMode() runs on ItsSremSsem {
if (PICS_IS_IUT_SECURED == true) {
f_acTriggerSecEvent(m_acDisableSecurity);
}
} // End of function f_initialiseSecuredMode()
/**
* @desc Triggers event in the test system adaptation.
* @param p_event The event to trigger
* @return FncRetCode
*/
function f_acTriggerSecEvent(template (value) AcSecPrimitive p_event) runs on ItsSremSsem return FncRetCode {
var FncRetCode v_ret := e_success;
acPort.send(p_event);
tc_ac.start;
alt {
[] acPort.receive(m_acSecResponseSuccess) {
tc_ac.stop;
}
[] acPort.receive {
tc_ac.stop;
log("*** " & __SCOPE__ & ": ERROR: Received unexpected message ***");
f_selfOrClientSyncAndVerdict("error", e_error);
}
[] tc_ac.timeout {
log("*** " & __SCOPE__ & ": ERROR: Timeout while waiting for adapter control event result ***");
f_selfOrClientSyncAndVerdict("error", e_timeout);
}
}
return v_ret;
}
} // End of group adapterControl
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
group altsteps {
/**
* @desc Default handling cf01 de-initialisation.
*/
altstep a_cf01Down() runs on ItsSremSsem {
[] a_shutdown() {
f_poDefault();
f_cfDown();
log("*** a_cf01Down: INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
stop;
}
}
/**
* @desc The base default.
*/
altstep a_default() runs on ItsSremSsem {
[] sremSsemPort.receive(mw_sremInd(mw_sremPdu(mw_defaultSrem))) {
log("*** " & testcasename() & ": INFO: SREMM received in default ***");
vc_sremReceived := true;
repeat;
}
[] sremSsemPort.receive(mw_ssemInd(mw_ssemPdu(mw_defaultSsem))) {
log("*** " & testcasename() & ": INFO: SREMM received in default ***");
vc_ssemReceived := true;
repeat;
}
[] sremSsemPort.receive {
log("*** " & testcasename() & ": ERROR: Received an unexpected message ***");
f_selfOrClientSyncAndVerdict("error", e_error);
}
[] any timer.timeout {
log("*** " & testcasename() & ": INCONC: Timeout while awaiting the reception of a message ***");
f_selfOrClientSyncAndVerdict("error", e_timeout);
}
[] a_shutdown() {
f_poDefault();
f_cfDown();
log("*** " & testcasename() & ": INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
stop;
}
}
/**
* @desc The default for handling upper tester messages.
*/
altstep a_utDefault() runs on ItsSremSsem {
var UtSremEventInd v_sremevent;
var UtSsemEventInd v_ssemevent;
[] utPort.receive(UtSremEventInd:?) -> value v_sremevent {
vc_utSremEvents[lengthof(vc_utSremEvents)] := v_sremevent;
[] utPort.receive(UtSsemEventInd:?) -> value v_ssemevent {
vc_utSsemEvents[lengthof(vc_utSsemEvents)] := v_ssemevent;
repeat;
}
[] utPort.receive {
log("*** " & testcasename() & ": INFO: Received unhandled/unknown UT message from IUT ***");
repeat;
}
}
} // End of group altsteps
group mapSpatConfigurationFunctions {
/**
* @desc Setups default configuration
* @param p_certificateId The certificate identifier the TA shall use in case of secured IUT
function f_cfUp(
in charstring p_certificateId := PX_CERT_FOR_TS
) runs on ItsSremSsem /* TITAN TODO: system ItsSremSsemSystem */ {
map(self:acPort, system:acPort);
map(self:utPort, system:utPort);
map(self:sremSsemPort, system:sremSsemPort);
// Connect
f_connect4SelfOrClientSync();
activate(a_cf01Down());
// Initialise secured mode
f_initialiseSecuredMode(p_certificateId);
//Initialze the IUT
f_prInitialState();
} // End of f_cfUp
/**
* @desc Deletes default configuration
*/
function f_cfDown() runs on ItsSremSsem /* TITAN TODO: system ItsSremSsemSystem */ {
// Initialise secured mode
f_uninitialiseSecuredMode();
unmap(self:acPort, system:acPort);
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
unmap(self:sremSsemPort, system:sremSsemPort);
f_disconnect4SelfOrClientSync();
} // End of f_cfDown
} // End of of mapSpatConfigurationFunctions
group preambles {
/**
* @desc The default preamble.
*/
function f_prDefault() runs on ItsSremSsem {
vc_default := activate(a_default());
activate(a_utDefault());
}
/**
* @desc Brings the IUT into an initial state.
* @return FncRetCode
*/
function f_prInitialState() runs on ItsSremSsem return FncRetCode {
var FncRetCode v_ret := e_success;
f_utInitializeIut(m_sremSsemInitialize);
f_prDefault();
return v_ret;
}
} // End of group preambles
group postambles {
/**
* @desc The default postamble.
*/
function f_poDefault() runs on ItsSremSsem {
//empty
}
} // End of group postambles
group sendFunctions {
* @desc Sends a IVI message
* @param p_sendMsg The IVI message to send.
* @param p_overrideSeqNo Overrides the sequence number with the stored one.
function f_sendSseMessage(
in template (value) SignalRequestMessage p_signalRequestMessage
) runs on ItsSremSsem {
sremSsemPort.send(
m_ssemReq(
m_ssemPdu(
m_ssem(
valueof(p_signalRequestMessage)
))));
} // End of group sendFunctions
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
group receiveFunctions {
/**
* @desc Awaits a SREM and returns it
* @param p_rcvMsg The expected message to be received.
* @param p_rcvdMsg The received message - OUT.
*/
function f_awaitSreMessage(
in template (present) SremInd p_rcvMsg,
out SremInd p_rcvdMsg
) runs on ItsSremSsem {
tc_ac.start;
alt {
[] sremSsemPort.receive(p_rcvMsg) -> value p_rcvdMsg {
tc_ac.stop;
}
[] tc_ac.timeout {
log("*** " & testcasename() & ": INFO: Timeout while awaiting the reception of a message ***");
f_selfOrClientSyncAndVerdict("error", e_timeout);
}
}
}
} // End of group receiveFunctions
group miscellaneousFunctions {
/**
* @desc Increases the RequestID number and handles the special case where the
* SremIdentification number reaches the limit of 32768 and will be reset to 0.
* @param p_requestID The RequestID number to increase.
* @return The increased RequestID number.
*/
function f_increaseRequestID(
in RequestID p_requestID
) return RequestID {
// if maximum number of 256 reached, reset it to 0
return ((p_requestID + 1) mod 256);
}
} // End of group miscellaneousFunctions