Commit f5b1839a authored by garciay's avatar garciay
Browse files

Align PIXIT document and code

Quality review
parent 0fe12cc8
Loading
Loading
Loading
Loading
+4 −4
Original line number Diff line number Diff line
@@ -800,11 +800,11 @@ module LibItsFntp_Functions {
        /**
         * @desc   Unknown broadcast VCI
         * @return An unknown broadcast VCI
         * @see PX_LINK_ID_UNKWNON_BC
         * @see PX_WL_LINK_ID_UNKWNON_BC
         * @verdict Unchanged
         */
        function f_getIutLinkIdUnknownBc() return Link_ID {
            return PX_LINK_ID_UNKWNON_BC;
        function f_getIutWlLinkIdUnknownBc() return Link_ID {
            return PX_WL_LINK_ID_UNKWNON_BC;
        }
        
        /**
+25 −15
Original line number Diff line number Diff line
@@ -94,12 +94,12 @@ module LibItsFntp_Pixits {
        /**
         * @desc Identifies the VCI for broadcast on ITS-S router 
         */
        modulepar EUI64 PX_WL_REMOTE_CIID_BC := '030008FFFFFF0000'O;
        modulepar EUI64 PX_WL_REMOTE_CIID_BC := 'FF0008FFFF01FFFF'O; 
        
        /**
         * @desc Identifies the VCI for multicast on ITS-S router 
         */
        modulepar EUI64 PX_WL_REMOTE_CIID_MC := '030008FFFF010001'O;
        modulepar EUI64 PX_WL_REMOTE_CIID_MC := 'EF0008FFFF011234'O;
        
        /**
         * @desc Identifies the VCI for unicast on ITS-S router (peer station)
@@ -109,7 +109,17 @@ module LibItsFntp_Pixits {
        /**
         * @desc Identifies an unknown CI on ITS-S router 
         */
        modulepar EUI64 PX_WL_LOCAL_CIID_UNKNOWN := '030008FFFF000000'O;
        modulepar EUI64 PX_WL_LOCAL_CIID_UNKNOWN := '030008FFFF020001'O;
        
        /**
         * @desc Identifies the VCI for multicast on ITS-S router
         */
        modulepar EUI64 PX_WL_REMOTE_CIID_UNKNOWN_UC := '030008FFFF020001'O; 
        
        /**
         * @desc Identifies an unknown CI on ITS-S router
         */
        modulepar EUI64 PX_WL_REMOTE_CIID_UNKNOWN_BC := 'FF0008FFFF02FFFF'O; 
        
    } // End of group routerWlanVcisMac
    
@@ -122,23 +132,23 @@ module LibItsFntp_Pixits {
         * @desc Identifies the CI on ITS-S host 
         * @see ISO 21218 - Clause 6.2 Link Identifier 
         */
        modulepar EUI64 PX_LAN_LOCAL_CIID := '03000AFFFF010000'O; 
        modulepar EUI64 PX_LAN_LOCAL_CIID := '03000AFFFFFF0000'O; 
        
        /**
         * @desc Identifies the VCI for broadcast on ITS-S host 
         */
        modulepar EUI64 PX_LAN_REMOTE_CIID_BC := '03000AFFFFFF0000'O;
        modulepar EUI64 PX_LAN_REMOTE_CIID_BC := 'FF000AFFFFFFFFFF'O;
        
        /**
         * @desc Identifies the VCI for unicast on ITS-S host 
         */
        modulepar EUI64 PX_LAN_REMOTE_CIID_UC := 'F3000AFFFF010001'O;
        modulepar EUI64 PX_LAN_REMOTE_CIID_UC := '03000AFFFFFF0001'O;
        
        /**
         * @desc Identifies a different VCI on ITS-S host 
         * @see ISO 21218 - Clause 6.2 Link Identifier 
         */
        modulepar EUI64 PX_LAN_DIFFERENT_LOCAL_CIID := '03000AFFFF020001'O; 
        modulepar EUI64 PX_LAN_DIFFERENT_LOCAL_CIID := '03000AFFFFFE0001'O; 
        
    } // End of routerLanVcisMac
    
@@ -148,28 +158,28 @@ module LibItsFntp_Pixits {
    group peerItsStationVcisMac {
        
        /**
         * @desc Identifies uniquely a specific CI in a specific "ITS-S Communication Unit"
         * @desc Identifies uniquely a specific CI in a specific ITS-SCU
         * @see ISO 21218 - Clause 6.2 Link Identifier
         */
        modulepar EUI64 PX_DEST_LOCAL_CIID := '030009FFFF010000'O;
        
        /**
         * @desc Identifies uniquely a specific CI in a specific "ITS-S Communication Unit" for broadcast
         * @desc Identifies uniquely a specific CI in a specific ITS-SCU for broadcast
         */
        modulepar EUI64 PX_DEST_REMOTE_CIID_BC := '030009FFFF01FFFF'O;
        
        /**
         * @desc Identifies uniquely a specific CI in a specific "ITS-S Communication Unit" for multicast
         * @desc Identifies uniquely a specific CI in a specific ITS-SCU for multicast
         */
        modulepar EUI64 PX_DEST_REMOTE_CIID_MC := '030009FFFF010001'O;
        
        /**
         * @desc Identifies uniquely a specific CI in a specific "ITS-S Communication Unit" for unicast (peer to peer)
         * @desc Identifies uniquely a specific CI in a specific ITS-SCU for unicast (peer to peer)
         */
        modulepar EUI64 PX_DEST_REMOTE_CIID_UC := '030009FFFF010001'O;
        
        /**
         * @desc Identifies a second VCI for unicast (peer to peer) on ITS-S host 
         * @desc Identifies a second VCI for unicast (peer to peer) on ITS-SCU 
         */
        modulepar EUI64 PX_SECOND_REMOTE_CIID_BC := '0000000000000000'O;
        
@@ -212,8 +222,8 @@ module LibItsFntp_Pixits {
        /**
         * @desc Identify an unknown VCI to be used to transmit the packet, i.e. the peer station, for Broadcast
         */
        modulepar Link_ID PX_LINK_ID_UNKWNON_BC := {
            remoteCIID := PX_WL_REMOTE_CIID_BC,
        modulepar Link_ID PX_WL_LINK_ID_UNKWNON_BC := {
            remoteCIID := PX_WL_REMOTE_CIID_UNKNOWN_BC,
            localCIID := PX_WL_LOCAL_CIID_UNKNOWN
        }
        
@@ -221,7 +231,7 @@ module LibItsFntp_Pixits {
         * @desc Identify an unknown VCI to be used to transmit the packet, i.e. the peer station, for Unicast
         */
        modulepar Link_ID PX_WL_LINK_ID_UNKWNON_UC := {
            remoteCIID := PX_WL_REMOTE_CIID_BC,
            remoteCIID := PX_WL_REMOTE_CIID_UNKNOWN_UC,
            localCIID := PX_WL_LOCAL_CIID_UNKNOWN
        }
        
+68 −68
Original line number Diff line number Diff line
@@ -87,21 +87,21 @@ module LibItsFsap_Templates {
                
                /**
                 * @desc    Send a GCregServer registration request for an ITS-S application
                 * @param   p_applicationID   The Application ID
                 * @param   p_applicationId   The Application ID
                 * @param   p_gCschedule      A set of scheduling information
                 * @param   p_serviceDataReg  Additional service data information
                 * @see ISO 24102-3 Table C.1 — MF-REQUESTs 
                 * @see ISO 24102-5 Clause 8.2.1 Groupcast registration 
                 */
                template (value) MF_Request m_mfRequestGcregServer(
                    in template (value) ApplicationID p_applicationID,
                    in template (value) ApplicationID p_applicationId,
                    in template (value) GCschedule p_gCschedule,
                    in template (value) ServiceDataReg p_serviceDataReg
                ) := {
                    fill := '0000'B,
                    mfReq := {
                        gCregServer := {
                            applicationID := p_applicationID,
                            applicationID := p_applicationId,
                            gCschedule := p_gCschedule,
                            priority := PX_USER_PRIORITY,
                            serviceDataReg := p_serviceDataReg
@@ -146,45 +146,45 @@ module LibItsFsap_Templates {
                
                /**
                 * @desc    Send template for a  GCregClient without a session, CTX is not requested
                 * @param   p_applicationID   The Application ID
                 * @param   p_serviceID       The globally unique ITS-AID of the ITS-S application
                 * @param   p_applicationId   The Application ID
                 * @param   p_serviceId       The globally unique ITS-AID of the ITS-S application
                 * @see ISO 24102-5 Clause 8.5
                 */
                template (value) MF_Request m_mfRequest_GCregClientWithNoSessionAndNoCTX(
                    in template (value) ApplicationID p_applicationID,
                    in template (value) ITSaid p_serviceID
                template (value) MF_Request m_mfRequest_gCregClientWithNoSessionAndNoCtx(
                    in template (value) ApplicationID p_applicationId,
                    in template (value) ITSaid p_serviceId
                ) := {
                    fill := '0000'B,
                    mfReq := {
                        gCregClient := {
                            applicationID := p_applicationID,
                            applicationID := p_applicationId,
                            priority := PX_USER_PRIORITY,
                            serviceID := p_serviceID,
                            serviceID := p_serviceId,
                            contextData := ''O
                        } // End of field 'gCregClient'
                    } // End of field 'mfReq'
                } // End of template m_mfRequest_GCregClientWithNoSessionAndNoCTX
                } // End of template m_mfRequest_gCregClientWithNoSessionAndNoCtx
                
                /**
                 * @desc    Send template for a  GCregClient without a session, CTX is requested
                 * @param   p_applicationID   The Application ID
                 * @param   p_serviceID       The globally unique ITS-AID of the ITS-S application
                 * @param   p_applicationId   The Application ID
                 * @param   p_serviceId       The globally unique ITS-AID of the ITS-S application
                 * @see ISO 24102-5 Clause 8.3.1 Groupcast registration
                 */
                template (value) MF_Request m_mfRequest_GCregClientWithSessionAndCTX(
                    in template (value) ApplicationID p_applicationID,
                    in template (value) ITSaid p_serviceID
                template (value) MF_Request m_mfRequest_gCregClientWithSessionAndCtx(
                    in template (value) ApplicationID p_applicationId,
                    in template (value) ITSaid p_serviceId
                ) := {
                    fill := '0000'B,
                    mfReq := {
                        gCregClient := {
                            applicationID := p_applicationID,
                            applicationID := p_applicationId,
                            priority := PX_USER_PRIORITY,
                            serviceID := p_serviceID,
                            serviceID := p_serviceId,
                            contextData := ''O
                        } // End of field 'gCregClient'
                    } // End of field 'mfReq'
                } // End of template m_mfRequest_GCregClientWithSessionAndCTX
                } // End of template m_mfRequest_gCregClientWithSessionAndCtx
                
            } // End of group cregClientMessageSend
            
@@ -194,38 +194,38 @@ module LibItsFsap_Templates {
//                /**
//                 * @desc    Send template for GCregClient
//                 * @param p_hostITS_scuId   The ITS-SCU-ID of the ITS-S host where the service provider ITS-S application resides
//                 * @param p_serviceID       The globally unique ITS-AID of the ITS-S application
//                 * @param p_serviceId       The globally unique ITS-AID of the ITS-S application
//                 * @see ISO/CD 24102-5 Clause 8.3.1 Groupcast registration
//                 */
//                template (value) GCregClient m_gCregClient(
//                    in template (value) ITS_scuId p_hostITS_scuId,
//                    in template (value) ITSaid p_serviceID
//                    in template (value) ITSaid p_serviceId
//                ) := {
//                    applicationID := {
//                        hostITS_scuId := p_hostITS_scuId,
//                        seqNumber := 0
//                    }, // End of 'applicationID' field
//                    priority := 0,
//                    serviceID := p_serviceID,
//                    serviceID := p_serviceId,
//                    contextData := ''O
//                } // End of template m_gCregClient
//                
//                /**
//                 * @desc  Confirmation of the ITS-S application shall deregistration
//                 * @param p_hostITS_scuId  The ITS-SCU-ID of the ITS-S host where the service provider ITS-S application resides together with an ITS-S application reference number being unique at this ITS-SCU
//                 * @param p_serviceID      The globally unique ITS-AID of the ITS-S application
//                 * @param p_serviceId      The globally unique ITS-AID of the ITS-S application
//                 * @see ISO 24102-5 Clause 8.3.1
//                 */
//                template (present) GCregClient mw_gCregClient(
//                    in template (present) ITS_scuId p_hostITS_scuId,
//                    in template (present) ITSaid p_serviceID
//                    in template (present) ITSaid p_serviceId
//                ) := {
//                    applicationID := {
//                        hostITS_scuId := p_hostITS_scuId,
//                        seqNumber := ?
//                    }, // End of 'applicationID' field
//                    priority := ?,
//                    serviceID := p_serviceID,
//                    serviceID := p_serviceId,
//                    contextData := ?
//                } // End of template mw_gCregClient
//                
@@ -275,13 +275,13 @@ module LibItsFsap_Templates {
                /**
                 * @desc    Send template for a SAM from a service user ITS station, notified by the groupcast communication manager to the groupcast manager
                 * @param   p_link        Source_address
                 * @param   p_serverID    Server identifier
                 * @param   p_serverId    Server identifier
                 * @param   p_serviceList Service list descroption
                 * @see ISO 24102-5 Clause 8.3.4 Reception of SAM and transmission of CTX
                 */
                template (value) MF_Request m_mfRequest_SAMrxNot( 
                template (value) MF_Request m_mfRequest_samRxNot( 
                    in template (value) LLserviceAddr p_link, 
                    in template (value) StationID p_serverID, 
                    in template (value) StationID p_serverId, 
                    in template (value) ServiceList p_serviceList 
                ) := {
                    fill := '0000'B,
@@ -291,14 +291,14 @@ module LibItsFsap_Templates {
                            sam := {
                                fmtID := PX_FMTID_SAM, 
                                version := PX_VERSION_FSAP, 
                                serverID := p_serverID,
                                serverID := p_serverId,
                                serviceList := p_serviceList,
                                channelList := { },
                                ipServList := { }
                            } // End of field 'sam'
                        } // End of field 'sAMrxNot'
                    } // End of field 'mfReq'
                } // End of template m_mfRequest_SAMrxNot
                } // End of template m_mfRequest_samRxNot
                
            } // End of group samMessageSend
            
@@ -318,20 +318,20 @@ module LibItsFsap_Templates {
                
                /**
                 * @desc    Receive template for SAM
                 * @param   p_applicationID   The Application ID
                 * @param   p_serverID        Server identifier
                 * @param   p_applicationId   The Application ID
                 * @param   p_serverId        Server identifier
                 * @param   p_serviceData     Additional SAM service data information
                 * @see ISO 24102-5 Clause 8.3.4 Reception of SAM and transmission of CTX
                 */
                template (present) MF_Command mdw_mfCommand_gcSam(
                    in template (present) ApplicationID p_applicationID,
                    in template (present) StationID p_serverID,
                    in template (present) ApplicationID p_applicationId,
                    in template (present) StationID p_serverId,
                    in template (present) SAMserviceData p_serviceData
                ) modifies mw_mfCommand_any := {
                    mfCmd := {
                        gCsam := {
                            applicationID := p_applicationID,
                            serverID := p_serverID,
                            applicationID := p_applicationId,
                            serverID := p_serverId,
                            serviceData := p_serviceData
                        } // End of header 'gCsam'
                    } // End of header 'mfCmd'
@@ -339,40 +339,40 @@ module LibItsFsap_Templates {
                
                /**
                 * @desc    Receive template for GCsamctx
                 * @param   p_applicationID   The Application ID
                 * @param   p_serverID        Server identifier
                 * @param   p_applicationId   The Application ID
                 * @param   p_serverId        Server identifier
                 * @param   p_serviceInfo     Additional service data information
                 * @see     ISO 24102-5 Clause 8.3.4 Reception of SAM and transmission of CTX
                 */
                template (present) MF_Command mdw_mfCommand_gCsamctx(
                    in template (present) ApplicationID p_applicationID,
                    in template (present) StationID p_serverID,
                template (present) MF_Command mdw_mfCommand_gcSamCtx(
                    in template (present) ApplicationID p_applicationId,
                    in template (present) StationID p_serverId,
                    in template (present) ServiceInfo p_serviceInfo
                ) modifies mw_mfCommand_any := {
                    mfCmd := {
                        gCsamctx := {
                            applicationID := p_applicationID,
                            serverID := p_serverID,
                            applicationID := p_applicationId,
                            serverID := p_serverId,
                            serviceInfo := p_serviceInfo
                        } // End of header 'gCsam'
                    } // End of header 'mfCmd'
                } // End of template mdw_mfCommand_gCsamctx
                } // End of template mdw_mfCommand_gcSamCtx
                
                /**
                 * @desc    Receive template for SAMserviceData
                 * @param p_serviceID       Service identifier
                 * @param p_serviceId       Service identifier
                 * @param p_serviceData     Additional service data information
                 * @param p_providerPort    Service user port number
                 */
                template (present) SAMserviceData mw_samDataServerciceWithAccessTechAndNonIP( 
                    in template (present) ITSaid p_serviceID, 
                    in template (present) ITSaid p_serviceId, 
                    in template (present) ServiceData p_serviceData, 
                    in template (present) PortNumber p_providerPort 
                ) := { 
                    fill := ?, 
                    servData := { 
                        nonipService := { 
                            serviceID := p_serviceID, 
                            serviceID := p_serviceId, 
                            serviceData := p_serviceData, 
                            providerPort := p_providerPort 
                        } // End of field 'nonipService'
@@ -481,19 +481,19 @@ module LibItsFsap_Templates {
                
                /**
                 * @desc    Receive template for GCctx
                 * @param   p_applicationID     The application ID
                 * @param   p_applicationId     The application ID
                 * @param   p_clientID          Client identifier
                 * @param   p_serviceContext    Additional service context information
                 * @see ISO 24102-5 Clause 8.2.6 Reception of CTX
                 */
                template (present) MF_Command mdw_mfCommand_gCctx( 
                    in template (present) ApplicationID p_applicationID, 
                    in template (present) ApplicationID p_applicationId, 
                    in template (present) StationID p_clientID, 
                    in template (present) CTXserviceData p_serviceContext 
                ) modifies mw_mfCommand_any := { 
                    mfCmd := {
                        gCctx := {
                            applicationID := p_applicationID, 
                            applicationID := p_applicationId, 
                            clientID := p_clientID, 
                            serviceContext := p_serviceContext 
                        } // End of header 'gCctx'
@@ -547,16 +547,16 @@ module LibItsFsap_Templates {
                
                /**
                 * @desc    Receive template for CTX in non-ip context
                 * @param   p_serviceID     The globally unique ITS-AID of the ITS-S application
                 * @param   p_serviceId     The globally unique ITS-AID of the ITS-S application
                 * @param   p_userPort      Service port number
                 * @see ISO2410-5 Clause 8.2.1 Groupcast registration
                 * @see ISO2410-5 Figure 9 — serviceList
                 */
                template (present) NonipContext mw_nonipContext( 
                    in template (present) ITSaid p_serviceID, 
                    in template (present) ITSaid p_serviceId, 
                    in template (present) PortNumber p_userPort 
                ) := { 
                    serviceID := p_serviceID, 
                    serviceID := p_serviceId, 
                    contextData := ?, 
                    userPort := p_userPort 
                } // End of template mw_nonipContext 
@@ -574,18 +574,18 @@ module LibItsFsap_Templates {
                
                /**
                 * @desc    Receive template for CTXserviceData
                 * @param   p_serviceID     The globally unique ITS-AID of the ITS-S application
                 * @param   p_serviceId     The globally unique ITS-AID of the ITS-S application
                 * @param   p_contextData   Additional context data information for non-IP based services (timeout information)
                 * @param   p_userPort      Service port number
                 */
                template (present) CTXserviceData mdw_ctxServiceDataNonIP(
                    in template (present) ITSaid p_serviceID,
                    in template (present) ITSaid p_serviceId,
                    in template (present) ContextData p_contextData,
                    in template (present) PortNumber p_userPort
                ) modifies mw_ctxDataServercice_any := {
                    servData := {
                        nonipContext := {
                            serviceID := p_serviceID,
                            serviceID := p_serviceId,
                            contextData := p_contextData,
                            userPort := p_userPort
                        } // End of field 'nonipService'