LibS1AP_Steps.ttcn 36.2 KB
Newer Older
garciay's avatar
garciay committed
 *    @author   ETSI / STF519
garciay's avatar
garciay committed
 *    @desc     This module provides functions used in S1AP.
 *    @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.
 *    @see      ETSI TS 136 413 / 3GPP TS 36.413 version 13.4.0 Release 13
garciay's avatar
garciay committed
module LibS1AP_Steps {
    
garciay's avatar
garciay committed
    // LibCommon
    import from LibCommon_Sync all;
garciay's avatar
garciay committed
    import from LibCommon_VerdictControl all;
    import from LibCommon_BasicTypesAndValues all;
garciay's avatar
garciay committed
    // LibS1AP
    import from S1AP_PDU_Descriptions language "ASN.1:1997" all;
pintar's avatar
pintar committed
    import from LibS1AP_TypesAndValues all;
garciay's avatar
garciay committed
    import from LibS1AP_Interface all;
    import from LibS1AP_Pixits all;
    import from LibS1AP_Templates all;
    
garciay's avatar
garciay committed
    /**
     * @desc Common functions description
     */
    group commonFunctions {
garciay's avatar
garciay committed
         * @desc  Indicate if the provided value is greather or equal to 0
         * @return true if value of p_int greater than 0
         * @param p_int - integer value
         */
        function f_gtZero( // FIXME Do we really need a function for <= mathematical operation???
garciay's avatar
garciay committed
                          in integer p_int
        ) return boolean {
            if (p_int > 0){
                return true;
            }
            else{
                return false;
            }
garciay's avatar
garciay committed
        } // End of function f_gtZero
        
garciay's avatar
garciay committed
         * @desc  Increment the provided value by one
         * @return incremented value of p_int 0
garciay's avatar
garciay committed
         * @param p_int - integer value
         */
        function f_inc(
                       inout UInt32 p_int
        ) return UInt32 {
garciay's avatar
garciay committed
            p_int := p_int + 1;
            return p_int;
garciay's avatar
garciay committed
        } // End of function f_inc
        
garciay's avatar
garciay committed
    } // End of group commonFunctions
garciay's avatar
garciay committed
    /**
     * @desc Receive functions description
     */
    group receivePDU {
garciay's avatar
garciay committed
        
garciay's avatar
garciay committed
         *  @desc    This is a test step that assign common S1AP
garciay's avatar
garciay committed
         *  @param   p_PDU Extract the message payload from the S1AP PDU
garciay's avatar
garciay committed
         */
        function f_S1APPDU_Get(
                               inout S1AP_PDU p_PDU
        ) runs on S1APComponent {
            
            vc_recvS1AP_PDU := p_PDU;
            
            if (ischosen(p_PDU.initiatingMessage)) {
                //TODO...
            }
            if (ischosen(p_PDU.successfulOutcome)) {
                //TODO...
            }
            if (ischosen(p_PDU.unsuccessfulOutcome)) {
                 //TODO...
            }
        } // End of function f_S1APPDU_Get
        
        /**
garciay's avatar
garciay committed
         * @desc Receive S1AP PDU from protocol port
garciay's avatar
garciay committed
         * @param p_PDU template of the message to be received
         */
        function f_recv_S1AP_PDU(
                                 in template S1AP_PDU p_PDU
        ) runs on S1APComponent {
            var S1AP_PDU v_PDU;
garciay's avatar
garciay committed
            
            tc_wait.start;
garciay's avatar
garciay committed
            alt {
                [] S1_MMEeNB_P.receive(p_PDU) -> value v_PDU {
                    tc_wait.stop;
garciay's avatar
garciay committed
                    f_S1APPDU_Get(v_PDU)
                }
                [] tc_wait.timeout {
                    setverdict(inconc,"*** " & __SCOPE__ & ": INCONC: Message was not received in due time. ***");
garciay's avatar
garciay committed
                    //Stop the component in case of timeout
                    all timer.stop;
                    f_componentStop();
                }
garciay's avatar
garciay committed
            }
            
        } // End of function f_recv_S1AP_PDU
garciay's avatar
garciay committed
        /**
garciay's avatar
garciay committed
         * @desc Receive S1AP PDU with InitiatingMessage payload from protocol port
         * @param p_initiatingMessage Receive template for InitiatingMessage message
garciay's avatar
garciay committed
         */
        function f_recv_S1AP_initiatingMessage(
garciay's avatar
garciay committed
                                               template (present) InitiatingMessage p_initiatingMessage := ?
garciay's avatar
garciay committed
        ) runs on S1APComponent {
garciay's avatar
garciay committed
            f_recv_S1AP_PDU( { initiatingMessage := p_initiatingMessage })
garciay's avatar
garciay committed
        } // End of function f_recv_S1AP_initiatingMessage
        
        /**
garciay's avatar
garciay committed
         * @desc Receive S1AP PDU with SuccessfulOutcome payload from protocol port
         * @param p_successfulOutcome Receive template for SuccessfulOutcome message
garciay's avatar
garciay committed
         */
        function f_recv_S1AP_successfulOutcome(
garciay's avatar
garciay committed
                                               template (present) SuccessfulOutcome p_successfulOutcome := ?
garciay's avatar
garciay committed
        ) runs on S1APComponent {
            f_recv_S1AP_PDU( {successfulOutcome := p_successfulOutcome})
garciay's avatar
garciay committed
        } // End of f_recv_S1AP_successfulOutcome
        
        /**
garciay's avatar
garciay committed
         * @desc Receive S1AP PDU with UnsuccessfulOutcome payload from protocol port
         * @param p_unsuccessfulOutcome Receive template for UnsuccessfulOutcome message
garciay's avatar
garciay committed
         */
        function f_recv_S1AP_unsuccessfulOutcome(
garciay's avatar
garciay committed
                                                 template (present) UnsuccessfulOutcome p_unsuccessfulOutcome := ?
garciay's avatar
garciay committed
        ) runs on S1APComponent {
            f_recv_S1AP_PDU( {unsuccessfulOutcome := p_unsuccessfulOutcome})
garciay's avatar
garciay committed
        } // End of function f_recv_S1AP_unsuccessfulOutcome
pintar's avatar
pintar committed
        /**
         * @desc Receive S1AP Message E_RABSetupResponse
         * @param p_value Receive template for E_RABSetupResponse IEs
         */
        function f_recv_E_RABSetupResponse(
                                           template (present) RecordOf_ProtocolIE p_value := ?
pintar's avatar
pintar committed
        ) runs on S1APComponent {
            f_recv_S1AP_successfulOutcome(mw_E_RABSetupResponse(p_value))
        } // End of f_recv_E_RABSetupResponse
        
garciay's avatar
garciay committed
        /**
         * @desc Receive S1AP Message TRACE FAILURE INDICATION
         * @param p_value Receive template for TRACE FAILURE INDICATION IEs
         */
        function f_recv_Trace_Failure_Indication(
                                                 template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_trace_Failure_Indication(p_value))
        } // End of f_recv_Trace_Failure_Indication
        
        /**
         * @desc Receive S1AP Message LOCATION REPORT
         * @param p_value Receive template for LOCATION REPORT IEs
         */
        function f_recv_Location_Report(
                                        template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_location_Report(p_value))
        } // End of f_recv_Location_Report
        
        /**
         * @desc Receive S1AP Message LOCATION REPORT FAILURE INDICATION
         * @param p_value Receive template for LOCATION REPORT FAILURE INDICATION IEs
         */
        function f_recv_Location_Report_Failure_Indication(
                                                           template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_location_Report_Failure_Indication(p_value))
        } // End of f_recv_Location_Report_Failure_Indication
        
        /**
         * @desc Receive S1AP Message WRITE-REPLACE WARNING RESPONSE
         * @param p_value Receive template for WRITE-REPLACE WARNING RESPONSE IEs
         */
        function f_recv_Write_Replace_Warning_Response(
                                                       template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_successfulOutcome(mw_write_Replace_Warning_Response(p_value))
        } // End of f_recv_Write_Replace_Warning_Response
        
        /**
         * @desc Receive S1AP Message WRITE-REPLACE WARNING RESPONSE
         * @param p_value Receive template for WRITE-REPLACE WARNING RESPONSE IEs
         */
        function f_recv_Kill_Response(
                                                       template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_successfulOutcome(mw_kill_Response(p_value))
        } // End of f_recv_Kill_Response
        
        /**
         * @desc Receive S1AP Message PWS RESTART INDICATION
         * @param p_value Receive template for PWS_RESTART_INDICATION IEs
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.13.5 PWS RESTART INDICATION
         */
        function f_recv_eNB_PWS_Restart_Indication(
                                                   template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_pWS_Restart_Indication(p_value))
        } // End of f_recv_eNB_PWS_Restart_Indication
        
        /**
         * @desc Receive S1AP Message PWS FAILURE INDICATION
         * @param p_value Receive template for PWS_FAILURE_INDICATION IEs
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.13.6 PWS FAILURE INDICATION
         */
        function f_recv_eNB_PWS_Failure_Indication(
                                                   template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_pWS_Failure_Indication(p_value))
        } // End of f_recv_eNB_PWS_Failure_Indication
        
        /**
         * @desc Receive S1AP Message ENB DIRECT INFORMATION TRANSFER
         * @param p_value Receive template for ENB_DIRECT_INFORMATION_TRANSFER IEs
garciay's avatar
garciay committed
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.14 eNB DIRECT INFORMATION TRANSFER
         */
        function f_recv_eNB_Direct_Information_Transfer(
                                                        template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_eNB_Direct_Information_Transfer(p_value))
        } // End of f_recv_eNB_Configuration_Transfer
        
garciay's avatar
garciay committed
        /**
         * @desc Receive S1AP Message TRACE START 
         * @param p_value Receive template for TRACE START IEs
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.11.1 TRACE START
         */
        function f_recv_Trace_Start(
                                    template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_trace_Start(p_value))
        } // End of f_recv_Trace_Start
        
        /**
         * @desc Receive S1AP Message DEACTIVATE TRACE 
         * @param p_value Receive template for DEACTIVATE TRACE IEs
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.11.3 DEACTIVATE TRACE
         */
        function f_recv_Deactivate_Trace(
                                         template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_deactivate_Trace(p_value))
        } // End of f_recv_Deactivate_Trace
        
        /**
         * @desc Receive S1AP Message LOCATION REPORTING CONTROL 
         * @param p_value Receive template for LOCATION_REPORTING_CONTROL IEs
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.12.1 LOCATION REPORTING CONTROL
         */
        function f_recv_Location_Reporting_Control(
                                                      template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_location_Reporting_Control(p_value))
        } // End of f_recv_Location_Reporting_Control
        
        /**
         * @desc Receive S1AP Message WRITE-REPLACE WARNING REQUEST 
         * @param p_value Receive template for WRITE_REPLACE_WARNING_REQUEST IEs
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.13.1 WRITE-REPLACE WARNING REQUEST
         */
        function f_recv_Write_Replace_Warning_Request(
                                                      template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_write_Replace_Warning_RequestResponse(p_value))
        } // End of f_recv_Write_Replace_Warning_Request
        
        /**
         * @desc Receive S1AP Message KILL_REQUEST
         * @param p_value Receive template forKILL_REQUEST IEs
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.13.3 KILL REQUEST
         */
        function f_recv_Kill_Request(
                                     template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_kill_RequestResponse(p_value))
        } // End of f_recv_Kill_Request
        
        /**
         * @desc Receive S1AP Message MME DIRECT INFORMATION TRANSFER
         * @param p_value Receive template for MME_DIRECT_INFORMATION_TRANSFER IEs
garciay's avatar
garciay committed
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.15 MME DIRECT INFORMATION TRANSFER
         */
        function f_recv_Mme_Direct_Information_Transfer(
                                                        template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_Mme_Direct_Information_Transfer(p_value))
        } // End of f_recv_Mme_Configuration_Transfer
        
        /**
         * @desc Receive S1AP Message ENB CONFIGURATION TRANSFER
         * @param p_value Receive template for ENB_CONFIGURATION_TRANSFER IEs
garciay's avatar
garciay committed
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.16 eNB CONFIGURATION TRANSFER
         */
        function f_recv_eNB_Configuration_Transfer(
                                                   template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_eNB_Configuration_Transfer(p_value))
        } // End of f_recv_eNB_Configuration_Transfer
        
garciay's avatar
garciay committed
        /**
         * @desc Receive S1AP Message MME Direct Information Transfer
         * @param p_value Receive template for MME DIRECT INFORMATION TRANSFER IEs
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.15 MME DIRECT INFORMATION TRANSFER
         */
        function fx_MME_Direct_Information_Transfer_procedure(
                                                              template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_Mme_Configuration_Transfer(p_value))
        } // End of fx_MME_Direct_Information_Transfer_procedure
        
        /**
         * @desc Receive S1AP Message MME CONFIGURATION TRANSFER
         * @param p_value Receive template for MME_CONFIGURATION_TRANSFER IEs
garciay's avatar
garciay committed
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.17 MME CONFIGURATION TRANSFER
         */
        function f_recv_Mme_Configuration_Transfer(
                                                   template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_Mme_Configuration_Transfer(p_value))
        } // End of f_recv_Mme_Configuration_Transfer
        
        /**
         * @desc Receive S1AP Message DOWNLINK_UE_ASSOCIATED_LPPA_TRANSPORT
         * @param p_value Receive template for DOWNLINK_UE_ASSOCIATED_LPPA_TRANSPORT IEs
garciay's avatar
garciay committed
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.19.1 DOWNLINK UE ASSOCIATED LPPA TRANSPORT
         */
        function f_recv_Downlink_UE_Associated_Lppa_Transport(
                                                              template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_DownlinkUEAssociatedLppaTransport(p_value))
        } // End of f_recv_Downlink_UE_Associated_Lppa_Transport
        
        /**
         * @desc Receive S1AP Message UPLINK_UE_ASSOCIATED_LPPA_TRANSPORT
         * @param p_value Receive template for UPLINK_UE_ASSOCIATED_LPPA_TRANSPORT IEs
garciay's avatar
garciay committed
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.17 MME CONFIGURATION TRANSFER
         */
        function f_recv_Uplink_UE_Associated_Lppa_Transport(
                                                            template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_UplinkUEAssociatedLppaTransport(p_value))
        } // End of f_recv_Uplink_UE_Associated_Lppa_Transport
        
        /**
         * @desc Receive S1AP Message DOWNLINK_NON_UE_ASSOCIATED_LPPA_TRANSPORT
         * @param p_value Receive template for DOWNLINK_NON_UE_ASSOCIATED_LPPA_TRANSPORT IEs
garciay's avatar
garciay committed
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.19.3 DOWNLINK NON UE ASSOCIATED LPPA TRANSPORT
         */
        function f_recv_Downlink_Non_UE_Associated_Lppa_Transport(
                                                                  template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_DownlinkNonUEAssociatedLppaTransport(p_value))
        } // End of f_recv_Downlink_Non_UE_Associated_Lppa_Transport
        
        /**
         * @desc Receive S1AP Message UPLINK_NON_UE_ASSOCIATED_LPPA_TRANSPORT
         * @param p_value Receive template for UPLINK_NON_UE_ASSOCIATED_LPPA_TRANSPORT IEs
garciay's avatar
garciay committed
         * @see ETSI TS 136 413 V13.4.0 Clause 9.1.19.4 UPLINK NON UE ASSOCIATED LPPA TRANSPORT
         */
        function f_recv_Uplink_Non_UE_Associated_Lppa_Transport(
                                                                template (present) RecordOf_ProtocolIE p_value := ?
        ) runs on S1APComponent {
            f_recv_S1AP_initiatingMessage(mw_UplinkNonUEAssociatedLppaTransport(p_value))
        } // End of f_recv_Uplink_Non_UE_Associated_Lppa_Transport
        
garciay's avatar
garciay committed
    } // End of group receivePDU
garciay's avatar
garciay committed
    /**
     * @desc Send functions description
     */
    group sendPDU {
garciay's avatar
garciay committed
        
garciay's avatar
garciay committed
         *  @desc    This is a test step that assign common S1AP
garciay's avatar
garciay committed
         *  @param p_PDU The S1AP protocol message to set up
garciay's avatar
garciay committed
         */
        function f_S1APPDU_Set(
                               inout template (value) S1AP_PDU p_PDU
        ) runs on S1APComponent {
            
            if (ischosen(p_PDU.initiatingMessage)) {
                //TODO...
                vc_sendS1AP_PDU:=valueof(p_PDU);
            }
garciay's avatar
garciay committed
            if (ischosen(p_PDU.successfulOutcome)) {
                //TODO...
                vc_sendS1AP_PDU:=valueof(p_PDU);
            }
garciay's avatar
garciay committed
            if (ischosen(p_PDU.unsuccessfulOutcome)) {
                 //TODO...
                 vc_sendS1AP_PDU:=valueof(p_PDU);
            }
garciay's avatar
garciay committed
            
        } // End of function f_S1APPDU_Set
garciay's avatar
garciay committed
        
garciay's avatar
garciay committed
         * @desc Send S1AP PDU to protocol port
         * @param p_PDU template value message to be send
         */
garciay's avatar
garciay committed
        function f_send_S1AP_PDU(
                                 in template (value) S1AP_PDU p_PDU
        ) runs on S1APComponent {
            f_S1APPDU_Set(p_PDU);
            S1_MMEeNB_P.send(p_PDU);
garciay's avatar
garciay committed
        } // End of function f_send_S1APPDU
        
        /**
garciay's avatar
garciay committed
         * @desc Send S1AP PDU with InitiatingMessage payload from protocol port
         * @param p_initiatingMessage Send value template for InitiatingMessage message
garciay's avatar
garciay committed
         */
        function f_send_S1AP_initiatingMessage(
                                               in template (value) InitiatingMessage p_initiatingMessage
        ) runs on S1APComponent {
            f_send_S1AP_PDU( {initiatingMessage := p_initiatingMessage})
garciay's avatar
garciay committed
        } // End of function f_send_S1AP_initiatingMessage
garciay's avatar
garciay committed
        /**
garciay's avatar
garciay committed
         * @desc Send S1AP PDU with SuccessfulOutcome payload from protocol port
         * @param p_successfulOutcome Send value template for SuccessfulOutcome message
garciay's avatar
garciay committed
         */
        function f_send_S1AP_successfulOutcome(
                                               in template (value) SuccessfulOutcome p_successfulOutcome
garciay's avatar
garciay committed
        ) runs on S1APComponent {
            f_send_S1AP_PDU( {successfulOutcome := p_successfulOutcome})
garciay's avatar
garciay committed
        } // End of function f_send_S1AP_successfulOutcome
garciay's avatar
garciay committed
        /**
garciay's avatar
garciay committed
         * @desc Send S1AP PDU with UnsuccessfulOutcome payload from protocol port
         * @param p_unsuccessfulOutcome Send value template for UnsuccessfulOutcome message
garciay's avatar
garciay committed
         */
        function f_send_S1AP_unsuccessfulOutcome(
garciay's avatar
garciay committed
                                                 in template (value) UnsuccessfulOutcome p_unsuccessfulOutcome
        ) runs on S1APComponent {
            f_send_S1AP_PDU( {unsuccessfulOutcome := p_unsuccessfulOutcome})
garciay's avatar
garciay committed
        } // End of function f_send_S1AP_unsuccessfulOutcome 
pintar's avatar
pintar committed
        /**
         * @desc Send S1AP Message E-RAB_SetupRequest
         * @param p_value Send template with IE for E-RAB_SetupRequest
         */
        function f_send_E_RABSetupRequest(in template (value) RecordOf_ProtocolIE p_value
        ) runs on S1APComponent {
            f_send_S1AP_initiatingMessage(m_E_RABSetupRequest(p_value))
        } // End of function f_send_E_RABSetupRequest
        
garciay's avatar
garciay committed
        /**
         * @desc Send S1AP Message TRACE START
         * @param p_value Send template with IE for TRACE START
         */
        function f_send_Trace_Start(
                                    in template (value) RecordOf_ProtocolIE p_value
        ) runs on S1APComponent {
            f_send_S1AP_initiatingMessage(m_trace_Start(p_value))
        } // End of function f_send_Trace_Start
        
        /**
         * @desc Send S1AP Message DEACTIVATE TRACE 
         * @param p_value Send template with IE for DEACTIVATE TRACE
         */
        function f_send_deactivate_Trace(
                                         in template (value) RecordOf_ProtocolIE p_value
        ) runs on S1APComponent {
            f_send_S1AP_initiatingMessage(m_deactivate_Trace(p_value))
        } // End of function f_send_deactivate_Trace
        
        /**
         * @desc Send S1AP Message LOCATION REPORTING CONTROL
         * @param p_value Send template with IE for LOCATION REPORTING CONTROL
         */
        function f_send_Location_Reporting_Control(
                                                   in template (value) RecordOf_ProtocolIE p_value
        ) runs on S1APComponent {
            f_send_S1AP_initiatingMessage(m_location_Reporting_Control(p_value))
        } // End of function f_send_Location_Reporting_Control
        
        /**
         * @desc Send S1AP Message LOCATION REPORT FAILURE INDICATION
         * @param p_value Receive template for LOCATION REPORT FAILURE INDICATION IEs
         */
        function f_send_Location_Report_Failure_Indication(
                                                           template (value) RecordOf_ProtocolIE p_value
        ) runs on S1APComponent {
            f_send_S1AP_initiatingMessage(m_location_Report_Failure_Indication(p_value))
        } // End of f_send_Location_Report_Failure_Indication
        
        /**
         * @desc Send S1AP Message WRITE-REPLACE WARNING REQUEST
         * @param p_value Send template with IE for WRITE-REPLACE WARNING REQUEST
         */
        function f_send_Write_Replace_Warning_Request(
                                                      in template (value) RecordOf_ProtocolIE p_value
        ) runs on S1APComponent {
            f_send_S1AP_initiatingMessage(m_write_Replace_Warning_Request(p_value))
        } // End of function f_send_Write_Replace_Warning_Request
        
        /**
         * @desc Send S1AP Message WRITE-REPLACE WARNING RESPONSE
         * @param p_value Send template with IE for WRITE-REPLACE WARNING RESPONSE
         */
        function f_send_Write_Replace_Warning_Response(
                                                      in template (value) RecordOf_ProtocolIE p_value
        ) runs on S1APComponent {
            f_send_S1AP_initiatingMessage(m_write_Replace_Warning_Response(p_value))
        } // End of function f_send_Write_Replace_Warning_Response
        
        /**
         * @desc Send S1AP Message KILL REQUEST
         * @param p_value Send template with IE for KILL REQUEST
         */
        function f_send_Kill_Request(
                                     in template (value) RecordOf_ProtocolIE p_value
        ) runs on S1APComponent {
            f_send_S1AP_initiatingMessage(m_kill_Request(p_value))
        } // End of function f_send_Kill_Request
        
        /**
         * @desc Send S1AP Message KILL REQUEST
         * @param p_value Send template with IE for KILL REQUEST
         */
        function f_send_Kill_Response(
                                     in template (value) RecordOf_ProtocolIE p_value
        ) runs on S1APComponent {
            f_send_S1AP_initiatingMessage(m_kill_Response(p_value))
        } // End of function f_send_Kill_Response
        
garciay's avatar
garciay committed
    } // End of group sendPDU
    /**
     * @desc Setup full procedure functions
garciay's avatar
garciay committed
     * @see ETSI TS 136 413 V13.4.0 Clause 8.1 List of S1AP Elementary procedures
     */
    group fullProcedures {
        
        /**
         * @desc Setup a full E-RAB Setup procedure
         */
        function f_rABSetupRequest() runs on S1APComponent {
            f_send_E_RABSetupRequest(m_E_RABSetupReqIEs(
                vc_MME_UE_ID,
                vc_ENB_UE_ID,
                {
                     m_E_RABToBeSetupItemBearerSUReq(1),
                     m_E_RABToBeSetupItemBearerSUReq(
                        2,
                        m_e_RABlevelQoSParameters
                        (255)
                     )
                 }
            ));
            f_recv_E_RABSetupResponse(mw_E_RABSetupResIEs_FailedToSetupList(
                vc_MME_UE_ID,
                vc_ENB_UE_ID,
                {
                      mw_E_RABSetupItemBearerSURes(1)
                },
                {
                    mw_E_RABItem(
                        2,
                        {
                            radioNetwork :=not_supported_QCI_value
                        }
                    )
                }
            ));
        } // End of function f_rABSetupRequest
        
        /**
         * @desc Setup a full E-RAB Release procedure
         */
        function f_rABSetupRelease() runs on S1APComponent {
            // TODO 
        } // End of function f_rABSetupRelease
        
garciay's avatar
garciay committed
        /**
         * @desc Initiate an Handover procedure
         */
        function f_initiate_handover() runs on S1APComponent {
            // TODO 
        } // End of function f_initiate_handover
        
        /**
         * @desc Initiate a Trace Start procedure
         */
        function f_initiate_traceStart() runs on S1APComponent {
            // TODO 
        } // End of function f_initiate_traceStart
        
        /**
         * @desc Initiate a Deactivate Trace procedure
         */
        function f_initiate_deactivateTrace() runs on S1APComponent {
            // TODO 
        } // End of function f_initiate_deactivateTrace
        
        /**
         * @desc Initiate a an Write-Replace Warning Request procedure
         */
        function f_writeReplaceWarningExchanges() runs on S1APComponent {
            // TODO 
        } // End of function f_writeReplaceWarningExchanges
        
    } // End of group fullProcedures
    
    group externalFunctions {
        
garciay's avatar
garciay committed
        /**
         * @desc Force the UE to be registered to a new cell
         * @return true on success, false otherwise
         */
        external function fx_move_UE_to_new_cell() return boolean;
        
        /**
         * @desc Check htat UE stop reporting at change of serving cell
         * @return true on success, false otherwise
         */
        external function fx_check_UE_stops_reporting() return boolean;
        
        /**
         * @desc Trigger a PWS Restart Indication procedure
         * @return true on success, false otherwise
         */
        external function fx_ENB_PWS_Restart_Indication_procedure_ind() return boolean;
        
        /**
         * @desc Trigger a PWS Failure Indication procedure
         * @return true on success, false otherwise
         */
        external function fx_ENB_PWS_Failure_Indication_procedure_ind() return boolean;
        
        /**
         * @desc Trigger an ENB direct information Transfer procedure
garciay's avatar
garciay committed
         * @return true on success, false otherwise
         */
        external function fx_ENB_Direct_Information_Transfer_procedure_ind() return boolean;
        
        /**
         * @desc Trigger an ENB Configuration Transfer procedure
garciay's avatar
garciay committed
         * @return true on success, false otherwise
         */
        external function fx_ENB_Configuration_Transfer_procedure_ind() return boolean;
        
garciay's avatar
garciay committed
        /**
         * @desc Trigger a Trace Start procedure
         * @return true on success, false otherwise
         */
        external function fx_MME_Trace_Start_ind() return boolean;
        
        /**
         * @desc Trigger a Deactivate Trace procedure
         * @return true on success, false otherwise
         */
        external function fx_MME_Deactivate_Trace_ind() return boolean;
        
        /**
         * @desc Trigger a Location Reporting Control procedure
         * @return true on success, false otherwise
         */
        external function fx_MME_Location_Reporting_Control_procedure_ind() return boolean;
        
        /**
         * @desc Trigger a Write-Replace Warning procedure
         * @return true on success, false otherwise
         */
        external function fx_MME_Write_Replace_Warning_procedure_ind() return boolean;
        
        /**
         * @desc Trigger a Kill procedure
         * @return true on success, false otherwise
         */
        external function fx_MME_Kill_procedure_ind() return boolean;
        
        /**
         * @desc Trigger an MME Direct Information Transfer procedure
         * @return true on success, false otherwise
         */
        external function fx_MME_Direct_Information_Transfer_procedure_ind() return boolean;
        
        /**
         * @desc Trigger an MME Configuration Transfer procedure
garciay's avatar
garciay committed
         * @return true on success, false otherwise
         */
        external function fx_MME_Configuration_Transfer_procedure_ind() return boolean;
        
        /**
         * @desc Trigger a LPPa Transport procedure using a UE associated signalling on eNodeB
         * @param p_associated_signalling_mode Set to true for an associated signalling mode, false otherwise
garciay's avatar
garciay committed
         * @return true on success, false otherwise
         */
        external function fx_eNB_LPPa_Transport_procedure_ind(
                                                              in boolean p_associated_signalling_mode
        ) return boolean;
        
        /**
         * @desc Trigger a LPPa Transport procedure using a UE associated signalling on MME
         * @param p_associated_signalling_mode Set to true for an associated signalling mode, false otherwise
garciay's avatar
garciay committed
         * @return true on success, false otherwise
         */
        external function fx_mme_LPPa_Transport_procedure_ind(
                                                              in boolean p_associated_signalling_mode
        ) return boolean;
        
    } // End of group externalFunctions
    
garciay's avatar
garciay committed
    group preambles {
        
        group preamble_S1AP{
garciay's avatar
garciay committed
            
            /**
             * @desc 
             * @verdict 
             */
            function f_preambleS1AP_MME()
            runs on S1APComponent {
                //TODO:...        
garciay's avatar
garciay committed
            } // End of function f_preambleS1AP_MME
garciay's avatar
garciay committed
            /**
             * @desc 
             * @verdict 
             */
            function f_preambleS1AP_eNB()
            runs on S1APComponent {
                //TODO:...        
garciay's avatar
garciay committed
            } // End of function f_preambleS1AP_eNB
            
        } // End of group preamble_S1AP
        
garciay's avatar
garciay committed
    } // End of group preambles
garciay's avatar
garciay committed
    group postambles {
garciay's avatar
garciay committed
        
        group postamble_S1AP{
garciay's avatar
garciay committed
            
            /**
             * @desc 
             * @verdict 
             */
            function f_postambleS1AP_MME()
            runs on S1APComponent {
garciay's avatar
garciay committed
                // TODO:...
            } // End of function f_postambleS1AP_MME
            
            /**
             * @desc 
             * @verdict 
             */
            function f_postambleS1AP_eNB()
            runs on S1APComponent {
garciay's avatar
garciay committed
                // TODO:...
            } // End of function f_postambleS1AP_eNB
            
        } // End of group postamble_S1AP
        
garciay's avatar
garciay committed
    } // End of group postambles
    
    /**
     * @desc Global 'altstep' statements description
     */
    group globalSteps {
        
        /**
         *  @desc    This is a test step that init S1AP component
         */
        function f_S1AP_Init_Component()
        runs on S1APComponent {
            
        } // End of function  f_S1AP_Init_Component
        
        /**
         * @desc Component termination
         */
        function f_S1AP_terminate_component()
        runs on S1APComponent {
            
            log("component terminated - forced!");
            deactivate;
            stop;
        } // End of function f_S1AP_terminate_component
        
        /**
         * @desc Component termination
         */
        function f_componentStop()
        runs on S1APComponent {
            
            syncPort.send(m_syncClientStop);
            S1_MMEeNB_P.clear;
            stop;
        } // End of function f_componentStop
        
        /**
         * @desc Original copied from older LibCommon_VerdictControl
         */
        function f_getVerdict() // FIXME Are you sure we really need it???
        return FncRetCode {
            
            var FncRetCode v_ret := e_error;
            if (getverdict == pass or getverdict == none) {
                v_ret := e_success;
            }
            return v_ret;
        } // End of function 
        
        /**
         * 
         * @desc Wait for particular time before next expected message
         */
        function f_wait(float p_time) // FIXME To be replace by LibCommon.f_sleep!!!
        runs on S1APComponent {
            
            tc_wait.start(p_time);
            alt {
                [] tc_wait.timeout{ }
            }
        } // End of function f_wait
        
    } // End of group globalSteps
garciay's avatar
garciay committed
    /**
     * @desc Default 'altstep' statements description
     */
    group defaultsTestStep {
garciay's avatar
garciay committed
        
        /**
         * @desc 
         * @verdict 
         */
        altstep a_defaultS1AP()
garciay's avatar
garciay committed
        runs on S1APComponent {
            [] any timer.timeout {
                all timer.stop;
                if (vc_serverStop==false) {
                    f_selfOrClientSyncAndVerdict("error", e_timeout);
                }
                else {
                    stop;
                }
            }
            [] S1_MMEeNB_P.receive (S1AP_PDU:{initiatingMessage := ?}) -> value vc_recvS1AP_PDUDefault {
                repeat;
            }
            [] S1_MMEeNB_P.receive (S1AP_PDU:{successfulOutcome := ?}) -> value vc_recvS1AP_PDUDefault {
                repeat;
            }
            [] S1_MMEeNB_P.receive (S1AP_PDU:{unsuccessfulOutcome := ?}) -> value vc_recvS1AP_PDUDefault {
                repeat;
            }
            [] S1_MMEeNB_P.receive (S1AP_PDU:?) -> value vc_recvS1AP_PDUDefault {
                if (vc_serverStop==false) {
                    f_selfOrClientSyncAndVerdict("error", e_error);
                }
                else {
                    stop;
                }
            }
            [] S1_MMEeNB_P.receive {
                if (vc_serverStop==false) {
                    f_selfOrClientSyncAndVerdict("error", e_error);
                }
                else {
                    stop;
                }
            }
            [] a_shutdown() {
                // Process temination on error
                log("*** a_defaultS1AP() : Process temination on error ***");
                // Terminate component execution
                stop;
            }
garciay's avatar
garciay committed
        } // End of altstep a_defaultS1AP
        
        altstep a_defaultS1AP_MME()
garciay's avatar
garciay committed
        runs on S1APComponent {
            [] any timer.timeout {
                all timer.stop;
                if (vc_serverStop==false) {
                    f_selfOrClientSyncAndVerdict("error", e_timeout);
                }
                else {
                    stop;
                }
            }
            //TODO:...
        } // End of altstep a_defaultS1AP_MME
        
        altstep a_defaultS1AP_eNB()
garciay's avatar
garciay committed
        runs on S1APComponent {
            [] any timer.timeout {
                all timer.stop;
                if (vc_serverStop==false) {
                    f_selfOrClientSyncAndVerdict("error", e_timeout);
                }
                else {
                    stop;
                }
            }
             //TODO:...
garciay's avatar
garciay committed
        } // End of altstep a_defaultS1AP_eNB
        
garciay's avatar
garciay committed
    } // End of group defaultsTestStep
garciay's avatar
garciay committed
} // End of module LibS1AP_Steps