SNIP_CLASSIC_FRTP_SECTION_8_8_3_Configurable_Interfaces

8.8.3 Configurable Interfaces This chapter lists all interfaces where the target API service of any upper layer, which require one or more of these mentioned interfaces to be called has to be set up by static configuration of the FlexRay Interface. The target function is usually a call-back function. The names of these kinds of interfaces are not fixed because they are configurable. These call-back services are specified and implemented in the upper layer BSW modules, which use the FlexRay Interface according to [5, AUTOSAR_EXP_LayeredSoftwareArchitecture]. The specific call-back notification is specified in the corresponding AUTOSAR SWS document (see chapter 3). In addition to upper layer AUTOSAR BSW modules, the FrIf can, with the functionality described within this specification, also support other non-AUTOSAR upper layer software modules (CDs), provided that these modules interact with the FrIf in the same manner as the upper layer AUTOSAR BSW modules. In particular, those non-AUTOSAR modules need to provide APIs as described in this chapter. [SWS_FrIf_05729] ⌈Configuration of <UL_RxIndication>: If the parameter FrIfUserRx IndicationUL is set to FR_AR_TP, <UL_RxIndication> must be FrArTp_RxIndication.⌋ () [SWS_FrIf_05730] ⌈Configuration of <UL_RxIndication>: If the parameter FrIfUserRx IndicationUL is set to FR_NM, <UL_RxIndication> must be FrNm_RxIndication.⌋() [SWS_FrIf_05731] ⌈Configuration of <UL_RxIndication>: If the parameter FrIfUserRx IndicationUL is set to FR_TP, <UL_RxIndication> must be FrTp_RxIndication.⌋() [SWS_FrIf_05732] ⌈Configuration of <UL_RxIndication>: If the parameter FrIfUserRx IndicationUL is set to PDUR, <UL_RxIndication> must be PduR_FrIfRxIndication.⌋() [SWS_FrIf_05733] ⌈Configuration of <UL_RxIndication>: If the parameter FrIfUserRx IndicationUL is set to XCP , <UL_RxIndication> must be Xcp_FrIfRxIndication.⌋() [SWS_FrIf_05434] ⌈Configuration of <UL_RxIndication>: If the parameter FrIfUserRx IndicationUL is set to FR_TSYN, <UL_RxIndication> must be FrTSyn_RxIndication.⌋() [SWS_FrIf_05734] ⌈Configuration of <UL_TxConfirmation>: If the parameter FrIfUser TxUL is set to FR_AR_TP, <UL_TxConfirmation> must be FrArTp_TxConfirmation.⌋() [SWS_FrIf_05735] ⌈Configuration of <UL_TxConfirmation>: If the parameter FrIfUser TxUL is set to FR_NM, <UL_TxConfirmation> must be FrNm_TxConfirmation.⌋() [SWS_FrIf_05736] ⌈Configuration of <UL_TxConfirmation>: If the parameter FrIfUser TxUL is set to FR_TP, <UL_TxConfirmation> must be FrTp_TxConfirmation.⌋() [SWS_FrIf_05737] ⌈Configuration of <UL_TxConfirmation>: If the parameter FrIfUser TxUL is set to PDUR, <UL_TxConfirmation> must be PduR_FrIfTxConfirmation.⌋() [SWS_FrIf_05738] ⌈Configuration of <UL_TxConfirmation>: If the parameter FrIfUser TxUL is set to XCP , <UL_TxConfirmation> must be Xcp_FrIfTxConfirmation.⌋() [SWS_FrIf_05739] ⌈Configuration of <UL_TriggerTransmit>: If the parameter FrIfUser TxUL is set to FR_AR_TP, <UL_TriggerTransmit> must be FrArTp_TriggerTransmit.⌋() [SWS_FrIf_05740] ⌈Configuration of <UL_TriggerTransmit>: If the parameter FrIfUser TxUL is set to FR_NM, <UL_TriggerTransmit> must be FrNm_TriggerTransmit.⌋() [SWS_FrIf_05741] ⌈Configuration of <UL_TriggerTransmit>: If the parameter FrIfUser TxUL is set to FR_TP, <UL_TriggerTransmit> must be FrTp_TriggerTransmit.⌋() [SWS_FrIf_05742] ⌈Configuration of <UL_TriggerTransmit>: If the parameter FrIfUser TxUL is set to PDUR, <UL_TriggerTransmit> must be PduR_TriggerTransmit.⌋() [SWS_FrIf_05743] ⌈Configuration of <UL_TriggerTransmit>: If the parameter FrIfUser TxUL is set to XCP, <UL_TriggerTransmit> must be Xcp_TriggerTransmit.⌋() [SWS_FrIf_05759] ⌈Configuration of <UL_TriggerTransmit>: If the parameter FrIfUser TxUL is set to FR_TSYN, <UL_TriggerTransmit> must be FrTSyn_TriggerTransmit.⌋() 8.8.3.1 <UL_RxIndication> [SWS_FrIf_05045] Definition of configurable interface <User_RxIndication> ⌈ Service Name <User_RxIndication> Syntax void <User_RxIndication> ( PduIdType RxPduId, const PduInfoType* PduInfoPtr ) Sync/Async Synchronous Reentrancy Reentrant for different PduIds. Non reentrant for the same PduId. RxPduId ID of the received PDU. Parameters (in) PduInfoPtr Contains the length (SduLength) of the received PDU, a pointer to a buffer (SduDataPtr) containing the PDU, and the MetaData related to this PDU. Parameters (inout) None Parameters (out) None Return value None Description Indication of a received PDU from a lower layer communication interface module. Available via configurable ⌋() Note: During the execution of this API service, the upper layer BSW module that is the final recipient of this PDU is expected to retrieve (i.e. copy) the SDU (i.e. the payload of the PDU) by means of the pointer PduInfoPtr which contains the received data address and received data length. Caveats of <UL_RxIndication>: This API service is called during the execution of the FlexRay Job List Execution Function. 8.8.3.2 <UL_TxConfirmation> [SWS_FrIf_05046] Definition of configurable interface <User_TxConfirmation> ⌈ Service Name <User_TxConfirmation> Syntax void <User_TxConfirmation> ( PduIdType TxPduId, Std_ReturnType result ) Sync/Async Synchronous Reentrancy Reentrant for different PduIds. Non reentrant for the same PduId. TxPduId ID of the PDU that has been transmitted. Parameters (in) result E_OK: The PDU was transmitted. E_NOT_OK: Transmission of the PDU failed. Parameters (inout) None Parameters (out) None Return value None Description The lower layer communication interface module confirms the transmission of a PDU, or the failure to transmit a PDU. Available via configurable ⌋() Caveats of <UL_TxConfirmation>: This API service is called during the execution of the FlexRay Job List Execution Function. 8.8.3.3 <UL_TriggerTransmit> [SWS_FrIf_05047] Definition of configurable interface <User_TriggerTransmit> ⌈ Service Name <User_TriggerTransmit> Syntax Std_ReturnType <User_TriggerTransmit> ( PduIdType TxPduId, PduInfoType* PduInfoPtr ) Sync/Async Synchronous Reentrancy Reentrant for different PduIds. Non reentrant for the same PduId. Parameters (in) TxPduId ID of the SDU that is requested to be transmitted. Parameters (inout) PduInfoPtr Contains a pointer to a buffer (SduDataPtr) to where the SDU data shall be copied, and the available buffer size in SduLengh. On return, the service will indicate the length of the copied SDU data in SduLength. Parameters (out) None ▽ △ Return value Std_ReturnType E_OK: SDU has been copied and SduLength indicates the number of copied bytes. E_NOT_OK: No SDU data has been copied. PduInfoPtr must not be used since it may contain a NULL pointer or point to invalid data. Description Within this API, the upper layer module (called module) shall check whether the available data fits into the buffer size reported by PduInfoPtr->SduLength. If it fits, it shall copy its data into the buffer provided by PduInfoPtr->SduDataPtr and update the length of the actual copied data in PduInfoPtr->SduLength. If not, it returns E_NOT_OK without changing PduInfoPtr. Available via configurable ⌋() Caveats of <UL_TriggerTransmit>: This API service is called during the execution of the FlexRay Job List Execution Function. 8.8.3.4 <Free_Op_A> [SWS_FrIf_05316] Definition of configurable interface <Free_Op_A> ⌈ Service Name <Free_Op_A> Syntax void <Free_Op_A> ( uint8 FrIf_CtrlIdx, uint16 FrIf_LPduIdx ) Sync/Async Synchronous Reentrancy Reentrant for different FrIf_LPduIdx, non reentrant for same FrIf_LPduIdx FrIf_CtrlIdx Index of the FlexRay CC to address. Parameters (in) FrIf_LPduIdx This index is used to uniquely identify a FlexRay frame. Parameters (inout) None Parameters (out) None Return value None Description User defined communication operation in order to support hardware specific or additional communication controller features to increase performance. Available via FrIf_Externals.h ⌋() Caveats of <Free_Op_A>: This API service is called during the execution of the FlexRay Job List Execution Function. 8.8.3.5 <Free_Op_B> [SWS_FrIf_05317] Definition of configurable interface <Free_Op_B> ⌈ Service Name <Free_Op_B> Syntax void <Free_Op_B> ( uint8 FrIf_CtrlIdx, uint16 FrIf_LPduIdx ) Sync/Async Synchronous ▽