SNIP_CLASSIC_FRIF_SECTION_8_3_19_FrIf_SetTransceiverMode

8.3.19 FrIf_SetTransceiverMode [SWS_FrIf_05034] Definition of API function FrIf_SetTransceiverMode Upstream requirements: SRS_Fr_05039 ⌈ Service Name FrIf_SetTransceiverMode Syntax Std_ReturnType FrIf_SetTransceiverMode ( uint8 FrIf_CtrlIdx, Fr_ChannelType FrIf_ChnlIdx, FrTrcv_TrcvModeType FrIf_TrcvMode ) Service ID [hex] 0x13 Sync/Async Synchronous Reentrancy Reentrant FrIf_CtrlIdx Index of the FlexRay CC to address. FrIf_ChnlIdx Index of the FlexRay Channel to address in scope of the FlexRay controller FrIf_CtrlIdx. Parameters (in) FrIf_TrcvMode Transceiver mode to be set. Parameters (inout) None Parameters (out) None Return value Std_ReturnType E_OK: The call of the FlexRay Transceiver Driver’s API service has returned E_OK. E_NOT_OK: The call of the FlexRay Transceiver Driver’s API service has returned E_NOT_OK. Description Wraps the FlexRay Transceiver Driver API function FrTrcv_SetTransceiverMode(). The enum value "FR_CHANNEL_AB" shall not be used. Available via FrIf.h ⌋ [SWS_FrIf_05210] ⌈If parameter FrIf_CtrlIdx of FrIf_SetTransceiverMode has an invalid value and if development error detection is enabled (i.e. FrIfDevErrorDetect equals ON), the function FrIf_SetTransceiverMode shall report development error code FRIF_E_INV_CTRL_IDX to the Det_ReportError service of the DET module.⌋ [SWS_FrIf_05211] ⌈If parameter FrIf_ChnlIdx of FrIf_SetTransceiverMode has an invalid value and if development error detection is enabled (i.e. FrIfDevErrorDetect equals ON), the function FrIf_SetTransceiverMode shall report development error code FRIF_E_INV_CHNL_IDX to the Det_ReportError service of the DET module.⌋ [SWS_FrIf_05212] ⌈The function FrIf_SetTransceiverMode shall wrap the FlexRay Transceiver Driver API function FrTrcv_SetTransceiverMode() by: 1. Translating (based on static FrIf module configuration) the tuple (FlexRay CC index FrIf_CtrlIdx | FlexRay Channel index FrIf_ChnlIdx) into a tuple (FlexRay Transceiver Driver | Driver-specific Transceiver index FrTrcv_TrcvIdx). 2. Setting parameters • FrTrcv_TrcvMode to FrIf_TrcvMode 3. Calling FrTrcv_SetTransceiverMode() of the determined FlexRay Driver module with the parameters determined as described above. ⌋ [SWS_FrIf_05213] ⌈Caveats of FrIf_SetTransceiverMode: The FlexRay Interface module has to be initialized with a call of FrIf_Init() before this API service may be called, see [SWS_FrIf_05003].⌋