SNIP_CLASSIC_DEM_SECTION_8_7_2_Optional_interfaces

8.7.2 Optional interfaces This section defines all interfaces, which are required to fulfill an optional functionality of the module. [SWS_Dcm_91002] Definition of optional interfaces in module Dcm ⌈ API Function Header File Description BndM_GetBlockPtr_<Block Id.Shortname> BndM_Externals.h – BndM_WriteBlock_<Block Id.Shortname> BndM_Externals.h Will persist the data in flash, that it can later directly accessed via BndM_GetBlockPtr API. The writing take a while and is finished after the successful callback xxx_BndMWriteBlockFinish BndM_WriteCancel BndM.h Cancels the writing BndM_WriteFinalize BndM.h Will trigger the finalization of writing phase. The finish of asynchronous processing will trigger the callback xxx_BndMWriteFinalizeFinish including the result of this operation. BndM_WriteStart BndM.h Will trigger the start of writing phase. The finish of asynchronous processing will trigger the callback xxx_BndMWriteStartFinish including the result of this operation BswM_Dcm_ApplicationUpdated BswM_Dcm.h This function is called by the DCM in order to report an updated application. BswM_Dcm_CommunicationMode _CurrentState BswM_Dcm.h Function called by DCM to inform the BswM about the current state of the communication mode. Dem_ClearDTC Dem.h Clears single DTCs, as well as groups of DTCs. Dem_DcmGetAvailableOBDMIDs Dem_Dcm.h Reports the value of a requested "availability-OBDMID" to the DCM upon a Service $06 request. Derived from that the tester displays the supported tests a mechanic can select from. API is needed in OBD-relevant ECUs only. API Availability: This API will be available only if ({ecuc(Dem/DemGeneral.DemOBDSupport)} != DEM_OBD_NO_OBD_SUPPORT) Dem_DcmGetDTCOfOBDFreeze Frame Dem_Dcm.h Gets DTC by freeze frame record number. API is needed in OBD-relevant ECUs only. API Availability: This API will be available only if ({ecuc(Dem/DemGeneral.DemOBDSupport)} != DEM_OBD_NO_OBD_SUPPORT) ▽ Manager △ API Function Header File Description Dem_DcmGetDTRData Dem_Dcm.h Reports a DTR data along with TID-value, UaSID, test result with lower and upper limit. API is needed in OBD-relevant ECUs only. API Availability: This API will be available only if ({ecuc(Dem/DemGeneral.DemOBDSupport)} != DEM_OBD_NO_OBD_SUPPORT) Dem_DcmGetNumTIDsOfOBDMID Dem_Dcm.h Gets the number of TIDs per (functional) OBDMID. This can be used by the DCM to iteratively request for OBD/TID result data within a loop from 0....numberOfTIDs-1 API is needed in OBD-relevant ECUs only. API Availability: This API will be available only if ({ecuc(Dem/DemGeneral.DemOBDSupport)} != DEM_OBD_NO_OBD_SUPPORT) Dem_DcmReadDataOfOBDFreeze Frame Dem_Dcm.h Gets data element per PID and index of the most important freeze frame being selected for the output of service $02. The function stores the data in the provided DestBuffer. API is needed in OBD-relevant ECUs only. API Availability: This API will be available only if ({ecuc(Dem/DemGeneral.DemOBDSupport)} != DEM_OBD_NO_OBD_SUPPORT) Dem_DisableDTCRecordUpdate Dem.h Disables the event memory update of a specific DTC (only one at one time). Dem_DisableDTCSetting Dem.h Disables the DTC setting for all DTCs assigned to the DemEventMemorySet of the addressed client. Dem_EnableDTCRecordUpdate Dem.h Enables the event memory update of the DTC disabled by Dem_DisableDTCRecordUpdate() before. Note: As the call to Dem_EnableDTCRecordUpdate is the last action in the sequence of disabling/ enabling a DTC, the caller is not interested in the return value. Therefore E_OK should be returned even if the DTC is enabled asynchronously. Dem_EnableDTCSetting Dem.h (Re)-Enables the DTC setting for all DTCs assigned to the DemEventMemorySet of the addressed client. Dem_GetDTCByOccurrenceTime Dem.h Gets the DTC by occurrence time. There is no explicit parameter for the DTC-origin as the origin always is DEM_DTC_ORIGIN_PRIMARY_ MEMORY. Dem_GetDTCSeverityAvailabilityMask Dem.h Gets the DTC Severity availability mask. Dem_GetDTCStatusAvailabilityMask Dem.h Gets the DTC Status availability mask of the selected fault memory. Dem_GetFunctionalUnitOfDTC Dem.h Gets the functional unit of the requested DTC. Dem_GetNextExtendedDataRecord Dem.h Gets extended data record for the DTC selected by Dem_SelectExtendedDataRecord. The function stores the data in the provided DestBuffer. Dem_GetNextFilteredDTC Dem.h Gets the next filtered DTC matching the filter criteria. For UDS services, the interface has an asynchronous behavior, because a large number of DTCs has to be processed. ▽ Manager △ API Function Header File Description Dem_GetNextFilteredDTCAndFDC Dem.h Gets the next filtered DTC and its associated Fault Detection Counter (FDC) matching the filter criteria. The interface has an asynchronous behavior, because a large number of DTCs has to be processed and the FDC might be received asynchronously from a SW-C, too. Dem_GetNextFilteredDTCAndSeverity Dem.h Gets the next filtered DTC and its associated Severity matching the filter criteria. The interface has an asynchronous behavior, because a large number of DTCs has to be processed. Dem_GetNextFilteredRecord Dem.h Gets the next freeze frame record number and its associated DTC stored in the event memory. The interface has an asynchronous behavior, because NvRAM access might be required. Dem_GetNextFreezeFrameData Dem.h Gets freeze frame data by the DTC selected by Dem_SelectFreezeFrameData. The function stores the data in the provided DestBuffer. Dem_GetNumberOfFilteredDTC Dem.h Gets the number of a filtered DTC. Dem_GetNumberOfFreezeFrame Records Dem.h This function returns the number of all freeze frame records currently stored in the primary event memory Dem_GetSeverityOfDTC Dem.h Gets the severity of the requested DTC. For large configurations and DTC-calibration, the interface behavior can be asynchronous (splitting the DTC-search into segments). Dem_GetSizeOfExtendedDataRecord Selection Dem.h Gets the size of Extended Data Record by DTC selected by the call of Dem_SelectExtendedData Record. Dem_GetSizeOfFreezeFrameSelection Dem.h Gets the size of freeze frame data by DTC selected by the call of Dem_SelectFreezeFrameData. Dem_GetStatusOfDTC Dem.h Gets the status of a DTC. For large configurations and DTC-calibration, the interface behavior can be asynchronous (splitting the DTC-search into segments). The DTCs of OBD Events Suppression shall be reported as Dem_WRONG_DTC. Dem_GetTranslationType Dem.h Gets the supported DTC formats of the ECU.The supported formats are configured via DemTypeOf DTCSupported. Dem_SetDTCFilter Dem.h Sets the DTC Filter. The server shall perform a bit-wise logical AND-ing operation between the parameter DTCStatusMask and the current UDS status in the server. In addition to the DTCStatusAvailabilityMask, the server shall return all DTCs for which the result of the AND-ing operation is non-zero [i.e. (statusOfDTC & DTCStatusMask) != 0]. The server shall process only the DTC Status bits that it is supporting. OBD Events Suppression shall be ignored for this computation. If no DTCs within the server match the masking criteria specified in the client’s request, no DTC or status information shall be provided following the DTCStatusAvailabilityMask byte in the positive response message (((statusOfDTC & DTCStatusMask) != 0) && ((severity & DTCSeverityMask) != 0)) == TRUE Dem_SetFreezeFrameRecordFilter Dem.h Sets a freeze frame record filter. Det_ReportError Det.h Service to report development errors. ▽ Manager △ API Function Header File Description IdsM_SetSecurityEvent IdsM.h This API is the application interface to report security events to the IdsM. IdsM_SetSecurityEventWithContext Data IdsM.h This API is the application interface to report security events with context data to the IdsM. IoHwAb_Dcm_<EcuSignalName> IoHwAb_Dcm.h This function provides control access to a certain ECU Signal to the DCM module (<EcuSignalname> is the symbolic name of an ECU Signal). The ECU signal can be locked and unlocked by this function. Locking ’freezes’ the ECU signal to the current value, the configured default value or a value given by the parameter ’signal’. IoHwAb_Dcm_Read<EcuSignal Name> IoHwAb_Dcm.h This function provides read access to a certain ECU Signal to the DCM module (<EcuSignalname> is the symbolic name of an ECU Signal). NvM_ReadBlock NvM.h Service to copy the data of the NV block to its corresponding RAM block. NvM_SetRamBlockStatus NvM.h Service for setting the RAM block status of a permanent RAM block or the status of the explicit synchronization of a NVRAM block. NvM_WriteBlock NvM.h Service to copy the data of the RAM block to its corresponding NV block. PduR_DcmCancelReceive PduR_Dcm.h Requests cancellation of an ongoing reception of a PDU in a lower layer transport protocol module. PduR_DcmCancelTransmit PduR_Dcm.h Requests cancellation of an ongoing transmission of a PDU in a lower layer communication module. SchM_ActMainFunction_Dcm <none> Invokes the SchM_ActMainFunction function to trigger the activation of a corresponding main processing function. ⌋() Dem_DcmReadDataOfOBDFreezeFrame is only required when OBD Service $02 is configured (see configuration parameter DcmDsdSidTabServiceId).