SNIP_CLASSIC_FR_SECTION_8_4_15_Fr_PrepareLPdu

8.4.15 Fr_PrepareLPdu [SWS_Fr_00107] Definition of API function Fr_PrepareLPdu Upstream requirements: SRS_Fr_05106 ⌈ Service Name Fr_PrepareLPdu Syntax Std_ReturnType Fr_PrepareLPdu ( uint8 Fr_CtrlIdx, uint16 Fr_LPduIdx ) Service ID [hex] 0x1f 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 Prepares a LPdu. Available via Fr.h ⌋ CC precondition for the function Fr_PrepareLPdu(): None. [SWS_Fr_00249] ⌈The function Fr_PrepareLPdu() shall perform the following tasks on FlexRay CC Fr_CtrIdx: 1. Figure out the physical resource (e.g., a buffer) mapped to the processing of the FlexRay frame identified by Fr_LpduIdx. 2. Configure the physical resource (a buffer) appropriate for Fr_LpduIdx operation (SlotId, Cycle filter, payload length, header CRC, etc.) if the MCG uses the reconfiguration feature4. 3. Return E_OK. ⌋ [SWS_Fr_00250] ⌈The function Fr_PrepareLPdu() shall be pre compile time configurable On/Off by the configuration parameter: FrPrepareLPduSupport.⌋ [SWS_Fr_00248] ⌈If the function Fr_PrepareLPdu() 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_00245] ⌈If development error detection for the Fr module is enabled, and if the function Fr_PrepareLPdu() is called before the successful initialization of Fr, then the function Fr_PrepareLPdu() shall raise the development error FR_E_INIT_FAILED.⌋ [SWS_Fr_00246] ⌈If development error detection for the Fr module is enabled, then the function Fr_PrepareLPdu() shall check the validity of the parameter Fr_CtrlIdx. If Fr_CtrlIdx is invalid, then the function Fr_PrepareLPdu() shall raise the development error FR_E_INV_CTRL_IDX.⌋ [SWS_Fr_00247] ⌈If development error detection for the Fr module is enabled, then the function Fr_PrepareLPdu() shall check the validity of the parameter Fr_LpduIdx. If Fr_LpduIdx is invalid, then the function Fr_PrepareLPdu() shall raise the development error FR_E_INV_LPDU_IDX.⌋ 4If the MCG decides to save message buffers using message buffer reconfiguration it assigns two different LPdus ( A and B) a single message buffer X. Each LPdu is linked to a (different) FrameTriggering configuration which contains the slot/cycle/channel assignment. Depending whether LPdu A or B is passed to Fr_PrepareLPdu(), the message buffer X is configured according to the slot/cycle/channel assignment of the related LPdu.