SNIP_CLASSIC_FRSM_SECTION_8_3_3_FrSM_GetCurrentComMode

8.3.3 FrSM_GetCurrentComMode [SWS_FrSM_00024] Definition of API function FrSM_GetCurrentComMode Upstream requirements: SRS_BSW_00310, SRS_BSW_00460, SRS_BSW_00461, SRS_BSW_ 00484 ⌈ Service Name FrSM_GetCurrentComMode Syntax Std_ReturnType FrSM_GetCurrentComMode ( NetworkHandleType network, ComM_ModeType* mode ) Service ID [hex] 0x41 Sync/Async Synchronous Reentrancy Reentrant for different networks. Non reentrant for the same network. Parameters (in) network Handle of the communication channel Parameters (inout) None Parameters (out) mode Pointer to the memory location where the current communication mode shall be stored ▽ △ Return value Std_ReturnType E_OK: Request accepted E_NOT_OK: Request not accepted Description Query the current communication mode. Available via FrSM.h ⌋ [SWS_FrSM_00025] ⌈The FrSM_GetCurrentComMode function shall write the current communication mode of the corresponding FlexRay cluster into the given memory location.⌋ [SWS_FrSM_00026] Upstream requirements: SRS_BSW_00483 ⌈The FrSM_GetCurrentComMode function shall determine the communication mode as follows: • If the FrSM state machine for the FlexRay cluster determined by the parameter network is in state FRSM_ONLINE or FRSM_LOW_NUMBER_OF_COLDSTARTERS, the communication mode is COMM_FULL_COMMUNICATION. • In any other case, the communication mode is COMM_NO_COMMUNICATION. ⌋ [SWS_FrSM_00027] Upstream requirements: SRS_BSW_00350 ⌈If development error detection is enabled and the parameter network has an invalid value, the FrSM_GetCurrentComMode function shall raise the development error code FRSM_E_INV_HANDLE and the FrSM_GetCurrentComMode function shall return E_NOT_OK.⌋ [SWS_FrSM_00028] Upstream requirements: SRS_BSW_00369, SRS_BSW_00323, SRS_BSW_00350 ⌈If development error detection is enabled and the parameter mode equals NULL_ PTR, the FrSM_GetCurrentComMode function shall raise the development error code FRSM_E_PARAM_POINTER and the FrSM_GetCurrentComMode function shall return E_NOT_OK.⌋ [SWS_FrSM_00060] Upstream requirements: SRS_BSW_00406, SRS_BSW_00350 ⌈If development error detection is enabled and the FrSM module has not been initialized using FrSM_Init, the FrSM_GetCurrentComMode function shall raise the development error code FRSM_E_UNINIT and the FrSM_GetCurrentComMode function shall return E_NOT_OK.⌋