SNIP_CLASSIC_CANIF_SECTION_8_3_15_CanIf_GetTrcvMode

8.3.15 CanIf_GetTrcvMode [SWS_CANIF_00288] Definition of API function CanIf_GetTrcvMode ⌈ Service Name CanIf_GetTrcvMode Syntax Std_ReturnType CanIf_GetTrcvMode ( uint8 TransceiverId, CanTrcv_TrcvModeType* TransceiverModePtr ) Service ID [hex] 0x0e Sync/Async Synchronous Reentrancy Non Reentrant Parameters (in) TransceiverId Abstracted CanIf TransceiverId, which is assigned to a CAN transceiver, which is requested for current operation mode. Parameters (inout) None Parameters (out) TransceiverModePtr Requested mode of requested network the Transceiver is connected to. Return value Std_ReturnType E_OK: Transceiver mode request has been accepted. E_NOT_OK: Transceiver mode request has not been accepted. Description This function invokes CanTrcv_GetOpMode and updates the parameter TransceiverModePtr with the value OpMode provided by CanTrcv. Available via CanIf.h ⌋ Note: For more details, please refer to the [2, Specification of CAN Transceiver Driver]. [SWS_CANIF_00363] ⌈The function CanIf_GetTrcvMode() shall call the function CanTrcv_GetOpMode(Transceiver, OpMode) on the corresponding requested CAN Transceiver Driver module.⌋ Note: The parameters of the function CanTrcv_GetOpMode are of type: • OpMode: CanTrcv_TrcvModeType (desired operation mode) • Transceiver: uint8 (Transceiver to which API call has to be applied) (see [2, Specification of CAN Transceiver Driver]) [SWS_CANIF_00364] Upstream requirements: SRS_BSW_00323 ⌈If parameter TransceiverId of CanIf_GetTrcvMode() has an invalid value, the CanIf shall report development error code CANIF_E_PARAM_TRCV to the Det_ReportError service of the DET module, when CanIf_GetTrcvMode() is called.⌋ [SWS_CANIF_00650] Upstream requirements: SRS_BSW_00323 ⌈If parameter TransceiverModePtr of CanIf_GetTrcvMode() has an invalid value, the CanIf shall report development error code CANIF_E_PARAM_POINTER to the Det_ReportError service of the DET module, when CanIf_GetTrcvMode() was called.⌋ [SWS_CANIF_00367] ⌈Configuration of CanIf_GetTrcvMode(): The number of supported transceiver types for each network is set up in the configuration phase (see CanIfTrcvCfg and CanIfTrcvDrvCfg). If no transceiver is used, this function may be omitted. Therefore, if no transceiver is configured in LT or PB class the API shall return with E_NOT_OK.⌋