SNIP_CLASSIC_CAN_SECTION_8_3_2_9_Can_GetControllerTxErrorCounter

8.3.2.9 Can_GetControllerTxErrorCounter [SWS_Can_00516] Definition of API function Can_GetControllerTxErrorCounter ⌈ Service Name Can_GetControllerTxErrorCounter Syntax Std_ReturnType Can_GetControllerTxErrorCounter ( uint8 ControllerId, uint8* TxErrorCounterPtr ) Service ID [hex] 0x31 Sync/Async Synchronous Reentrancy Non Reentrant for the same ControllerId Parameters (in) ControllerId CAN controller, whose current Tx error counter shall be acquired. Parameters (inout) None Parameters (out) TxErrorCounterPtr Pointer to a memory location, where the current Tx error counter of the CAN controller will be stored. Return value Std_ReturnType E_OK: Tx error counter available. E_NOT_OK: Wrong ControllerId, or Tx error counter not available. Description Returns the Tx error counter for a CAN controller. This value might not be available for all CAN controllers, in which case E_NOT_OK would be returned. Please note that the value of the counter might not be correct at the moment the API returns it, because the Tx counter is handled asynchronously in hardware. Applications should not trust this value for any assumption about the current bus state. Available via Can.h ⌋ [SWS_Can_00517] Upstream requirements: SRS_BSW_00406 ⌈If development error detection for the Can module is enabled: if the module is not yet initialized, the function Can_GetControllerTxErrorCounter shall raise development error CAN_E_UNINIT and return E_NOT_OK.⌋ [SWS_Can_00518] 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_GetControllerTxErrorCounter shall raise development error CAN_E_PARAM_CONTROLLER and return E_NOT_OK.⌋ [SWS_Can_00519] Upstream requirements: SRS_BSW_00323 ⌈If development error detection for the Can module is enabled: if the parameter TxErrorCounterPtr is a null pointer, the function Can_GetControllerTxErrorCounter shall raise development error CAN_E_PARAM_POINTER and return E_NOT_OK.⌋ [SWS_Can_00520] Upstream requirements: SRS_Can_01170 ⌈When the API Can_GetControllerTxErrorCounter is called with Controller Id as input parameter then Can driver shall read the Tx error counter register of Can Controller and shall return the Tx error count to upper layer.⌋