SNIP_CLASSIC_FRTRCV_SECTION_8_3_3_FrTrcv_GetTransceiverMode

8.3.3 FrTrcv_GetTransceiverMode [SWS_FrTrcv_00324] Definition of API function FrTrcv_GetTransceiverMode ⌈ Service Name FrTrcv_GetTransceiverMode Syntax Std_ReturnType FrTrcv_GetTransceiverMode ( uint8 FrTrcv_TrcvIdx, FrTrcv_TrcvModeType* FrTrcv_TrcvModePtr ) Service ID [hex] 0x05 Sync/Async Synchronous Reentrancy Reentrant Parameters (in) FrTrcv_TrcvIdx This zero based index identifies the transceiver within the context of the transceiver driver to which the API call has to be applied. Parameters (inout) None Parameters (out) FrTrcv_TrcvModePtr Pointer to structure of current transceiver state; the FlexRay transceiver driver will write the transceiver state information there. Return value Std_ReturnType E_OK: will be returned if the transceiver state has been provided E_NOT_OK: will be returned if the parameter is out of range. Output parameters remain unchanged. Description This function returns the actual state of the transceiver. Available via FrTrcv.h ⌋ [SWS_FrTrcv_00253] Upstream requirements: SRS_Fr_05167 ⌈The function FrTrcv_GetTransceiverMode shall return the state of the transceiver identified by FrTrcv_TrcvIdx.⌋ [SWS_FrTrcv_00281] Upstream requirements: SRS_Fr_05151 ⌈In case of a fault during transceiver access, the function FrTrcv_GetTransceiverMode shall raise the runtime error FRTRCV_E_FR_NO_CONTROL_TRCV (see also [SWS_FrTrcv_00237]).⌋ See FrTrcv_Init ([SWS_FrTrcv_00270]) for the provided state after the FlexRay transceiver driver initialization until the first operation mode change request. The number of supported FlexRay transceivers and their type is statically set in the configuration phase. [SWS_FrTrcv_00279] ⌈If development error detection for the module FrTrcv is enabled: if the parameter FrTrcv_TrcvIdx is out of range, the function FrTrcv_GetTransceiverMode shall raise the development error FRTRCV_E_FR_INVALID_TRCVIDX.⌋ [SWS_FrTrcv_00280] ⌈If development error detection for the module FrTrcv is enabled: if the transceiver has not been initialized, the function FrTrcv_GetTransceiverMode shall raise the development error FRTRCV_E_UNINIT.⌋ [SWS_FrTrcv_00397] ⌈When the caller provides a NULL pointer as a parameter value to the API FrTrcv_GetTransceiverMode, the return value shall be E_NOT_OK and the development error FRTRCV_E_PARAM_POINTER shall be reported to DET if development error detection is enabled.⌋