SNIP_CLASSIC_FR_SECTION_8_4_12_Fr_CancelTxLPdu

8.4.12 Fr_CancelTxLPdu [SWS_Fr_00610] Definition of API function Fr_CancelTxLPdu Upstream requirements: SRS_Fr_05024 ⌈ Service Name Fr_CancelTxLPdu Syntax Std_ReturnType Fr_CancelTxLPdu ( uint8 Fr_CtrlIdx, uint16 Fr_LPduIdx ) Service ID [hex] 0x2d Sync/Async Synchronous Reentrancy Non Reentrant for the same device Fr_CtrlIdx Index of FlexRay CC within the context of the FlexRay Driver. Parameters (in) Fr_LPduIdx This index is used to uniquely identify a FlexRay frame Parameters (inout) None Parameters (out) None Return value Std_ReturnType E_OK: API call finished successfully. E_NOT_OK: API call aborted due to errors. Description Cancels the already pending transmission of a LPdu contained in a controllers physical transmit resource (e.g. message buffer). Available via Fr.h ⌋ CC precondition for the function Fr_CancelTxLPdu(): None. [SWS_Fr_00611] ⌈The function Fr_CancelTxLPdu() shall perform the following tasks on FlexRay CC Fr_CtrIdx: • Figure out the physical resource (e.g., a buffer) mapped to the transmission of the FlexRay frame identified by Fr_LpduIdx. • If the physical resource figured out is actively pending for transmission, then the transmit request of this particular resource shall be terminated and E_OK returned. If no transmission is pending E_NOT_OK shall be returned, indicating that no such cancelation took place. ⌋ [SWS_Fr_00612] ⌈If a transmit resource is shared between more than 1 Lpdu (using reconfiguration mechanism of Fr_PrepareLPdu()), then the function Fr_CancelTxLPdu() must ensure that the transmit resource is correctly configured to match the properties of Fr_LpduIdx. This means that if a cancel transmit operation (Fr_ CancelTxLPdu()) is called for a particular Fr_LpduIdx and the Lpdu shares a single buffer with another Lpdu, then it shall check at the time of service invocation that the buffer is configured according to the Lpdu to be processed. The function Fr_CancelTxLPdu() shall return E_NOT_OK and abort the function execution if a wrong configuration is detected.⌋ [SWS_Fr_00613] ⌈If the function Fr_CancelTxLPdu() is able to and detects a hardware error while performing the requested functionality, then it shall call Dem_SetEventStatus() (FR_E_CTRL_TESTRESULT, DEM_EVENT_STATUS_FAILED) and return E_NOT_OK.⌋ [SWS_Fr_00614] ⌈If development error detection for the Fr module is enabled, and if the function Fr_CancelTxLPdu() is called before the successful initialization of Fr, then the function Fr_CancelTxLPdu() shall raise the development error FR_E_INIT_FAILED.⌋ [SWS_Fr_00615] ⌈If development error detection for the Fr module is enabled, then the function Fr_CancelTxLPdu() shall check the validity of the parameter Fr_CtrlIdx. If Fr_CtrlIdx is invalid, then the function Fr_CancelTxLPdu() shall raise the development error FR_E_INV_CTRL_IDX.⌋ [SWS_Fr_00616] ⌈If development error detection for the Fr module is enabled, then the function Fr_CancelTxLPdu() shall check the validity of the parameter Fr_LpduIdx. If Fr_LpduIdx is invalid, then the function Fr_CancelTxLPdu() shall raise the development error FR_E_INV_LPDU_IDX.⌋