SNIP_CLASSIC_CAN_SECTION_8_3_2_6_Can_GetControllerErrorState

8.3.2.6 Can_GetControllerErrorState [SWS_Can_91004] Definition of API function Can_GetControllerErrorState ⌈ Service Name Can_GetControllerErrorState Syntax Std_ReturnType Can_GetControllerErrorState ( uint8 ControllerId, Can_ErrorStateType* ErrorStatePtr ) Service ID [hex] 0x11 Sync/Async Synchronous Reentrancy Non Reentrant for the same ControllerId Parameters (in) ControllerId Abstracted CanIf ControllerId which is assigned to a CAN controller, which is requested for ErrorState. Parameters (inout) None Parameters (out) ErrorStatePtr Pointer to a memory location, where the error state of the CAN controller will be stored. Return value Std_ReturnType E_OK: Error state request has been accepted. E_NOT_OK: Error state request has not been accepted. Description This service obtains the error state of the CAN controller. Available via Can.h ⌋ [SWS_Can_91005] Upstream requirements: SRS_BSW_00406, SRS_BSW_00416 ⌈If development error detection for the Can module is enabled: if the module is not yet initialized, the function Can_GetControllerErrorState shall raise development error CAN_E_UNINIT and return E_NOT_OK.⌋ [SWS_Can_91006] Upstream requirements: SRS_BSW_00323 ⌈If development error detection for the Can module is enabled: if the parameter ControllerId is out of range, the function Can_GetControllerErrorState shall raise development error CAN_E_PARAM_CONTROLLER and return E_NOT_OK.⌋ [SWS_Can_91007] Upstream requirements: SRS_BSW_00323 ⌈If development error detection for the Can module is enabled: if the parameter ErrorStatePtr is a null pointer, the function Can_GetControllerErrorState shall raise development error CAN_E_PARAM_POINTER and return E_NOT_OK.⌋ [SWS_Can_91008] Upstream requirements: SRS_Can_01167 ⌈When the API Can_GetControllerErrorState() is called with Controller Id as input parameter then Can driver shall read the error state register of Can Controller and shall return the error status to upper layer.⌋