XCP Master Filter Plugin

Note

For an detailed description have a look at our ADTF 3 - Calibration Toolbox Guides page.

Plugin Information

Plugin Filename	xcp_master.adtfplugin
Plugin Description	xcp_master.plugindescription
Plugin Name	XCP Master Filter Plugin
License	ADTF
Support Mail	support@digitalwerk.net
Homepage URL	https://support.digitalwerk.net/

Plugin Versions

Plugin Version	3.11.4
Plugin File Version	1.0
adtf::calibtb	3.11.4
adtf	3.18.4
adtf::ucom	3.1.0

Component Information

Name	XCP Master Filter
CID	xcp_master.filter.calibtb.cid
Description	The XCP Master-Filter provides the functionality to read from and write to XCP frames.
Type	Filter

Properties

Name	Value	Type	Description	Subproperties
A2L or Xml Filename		cFilename	The A2L file that describes the ECU. You can also specify the converted file with the XML representation.
Connect During Startup	2	tUInt8	Handling the state, when the XCP Master tries to establish a connection to the ECU: 'Disabled': Useful if you are going to force connection establishment via the interface binding later on 'When XCP Master filter is started': The XCP master will try to connect to the ECU during filter startup 'After the session has been started': The connection will established after the complete FilterGraph has started.This is required, if you're using Streaming Sources, which are initialized after the XCP Master Filter(e.g. at communication over CAN-FD, the 'Vector CAN FD Device Receiver') 'Asynchronous Start': The XCP Master filter will start asynchronous and will not block the runlevel change.('Retries for Sending' property must be '0')	Value List: Disabled = 0 When XCP Master filter is started = 1 After the session has been started = 2 Asynchronous Start = 3
DAQ Complementary Connection Slave Id	-1	tInt32	If != -1, enables DAQ transport via the complementary connection with the given slave id.
Decode Frames	true	tBool	If enabled, signals will be extracted and decoded. Disable this when recording raw XPC frames to improve performance.
Default Aquisition DAQ Event Id	-1	tInt32	If a request for signal transmission does not specify a DAQ event id or polling interval and there is not default event id specified within the A2L, then this event wil be used. -1 --> none.
Default Aquisition DAQ Prescaler	1	tInt16	If a request for signal transmission does not specify a DAQ prescaler value and there is not default prescaler specified within the A2L, then this value will be used.
Default Aquisition Polling Interval	0	tInt64	If a request does not specify a DAQ event id or polling interval and there is not default event id specified within the A2L, then this polling interval will be used. 0 --> none.
Dump Buffer Layout	false	tBool	If enabled the DAQ Layout will be printed to the log.
Dump Frames	false	tBool	If enabled incoming and outgoing XCP Frames will be dumped to the log.
ECU Clock Is Synchronized.	false	tBool	If enabled and if the ADTF Stream Clock is a system clock, then the hardware timestamps will be used verbatim. Requires 'Use Synchronized Hardware Timestamps' = true.
Ignore Connection Error	false	tBool	If enabled, then the master will not abort startup if it cannot connect right away. This is useful if you are going to force connection establishment via the interface binding later on.
Ignore EPK Mismatch	false	tBool	When activated any possible EPK mismatch will be ignored.
Ignore Read Only flag	false	tBool	If enabled the master will allow writing signals/parameters that are marked as read-only.
Parameter Filename		cFilename	If not empty, the values of the parameters of the given file will be DOWNLOADed to the ECU after a connection has been established.
Playback Mode	false	tBool	If enabled, the filter will not try to comminicate with an actual ECU.
Reset FlexXCPBuffers	true	tBool	If enabled the Flexray Buffers will be reset upon connection
Retries for Sending	2	tInt16	Defines the count of retries for sending XCP frames to the ECU. If the property set to '-1', the XCP Master Filter tries to send the XCP frame until the ECU is responding or the session has been shut down.
Separate DAQ Counter	true	tBool	If enabled, a separate frame counter will be used to detect missing DAQ frames.
Store Additional Sample Info	true	tBool	If activated stores the hardware timestamp and DAQ List ID in the sample info.
Timeout [µs]	2000000	tInt32	The timeout after which the master will assume the ECU did not respond correctly.
Timestamp Tick Multiplier	true	tBool	If enabled, hw timestamps will be multipled by tick count, otherwise the will be dived by them.
Transport Layer	2	tInt32	Choose the used transport layer settings.	Value List: CAN = 1 TCP = 2 UDP = 3 Flexray = 4
Use Synchronized Hardware Timestamps	true	tBool	If enabled, the HW timestamps contained within XCP Frames will be used to improve the ADTF timestamps of the signal values. If disabled, only the recieve timestamps of the frames will be used.
XCP Commands/Calibration Commands/DOWNLOAD	true	tBool	Activates / Deactivates XCP command: DOWNLOAD
XCP Commands/Calibration Commands/DOWNLOAD_MAX	true	tBool	Activates / Deactivates XCP command: DOWNLOAD_MAX
XCP Commands/Calibration Commands/DOWNLOAD_NEXT	true	tBool	Activates / Deactivates XCP command: DOWNLOAD_NEXT
XCP Commands/Calibration Commands/MODIFY_BITS	true	tBool	Activates / Deactivates XCP command: MODIFY_BITS
XCP Commands/Calibration Commands/SHORT_DOWNLOAD	true	tBool	Activates / Deactivates XCP command: SHORT_DOWNLOAD
XCP Commands/DAQ and STIM Commands/ALLOC_DAQ	true	tBool	Activates / Deactivates XCP command: ALLOC_DAQ
XCP Commands/DAQ and STIM Commands/ALLOC_ODT	true	tBool	Activates / Deactivates XCP command: ALLOC_ODT
XCP Commands/DAQ and STIM Commands/ALLOC_ODT_ENTRY	true	tBool	Activates / Deactivates XCP command: ALLOC_ODT_ENTRY
XCP Commands/DAQ and STIM Commands/CLEAR_DAQ_LIST	true	tBool	Activates / Deactivates XCP command: CLEAR_DAQ_LIST
XCP Commands/DAQ and STIM Commands/FREE_DAQ	true	tBool	Activates / Deactivates XCP command: FREE_DAQ
XCP Commands/DAQ and STIM Commands/GET_DAQ_CLOCK	true	tBool	Activates / Deactivates XCP command: GET_DAQ_CLOCK
XCP Commands/DAQ and STIM Commands/GET_DAQ_EVENT_INFO	true	tBool	Activates / Deactivates XCP command: GET_DAQ_EVENT_INFO
XCP Commands/DAQ and STIM Commands/GET_DAQ_LIST_INFO	true	tBool	Activates / Deactivates XCP command: GET_DAQ_LIST_INFO
XCP Commands/DAQ and STIM Commands/GET_DAQ_LIST_MODE	true	tBool	Activates / Deactivates XCP command: GET_DAQ_LIST_MODE
XCP Commands/DAQ and STIM Commands/GET_DAQ_PROCESSOR_INFO	true	tBool	Activates / Deactivates XCP command: GET_DAQ_PROCESSOR_INFO
XCP Commands/DAQ and STIM Commands/GET_DAQ_RESOLUTION_INFO	true	tBool	Activates / Deactivates XCP command: GET_DAQ_RESOLUTION_INFO
XCP Commands/DAQ and STIM Commands/READ_DAQ	true	tBool	Activates / Deactivates XCP command: READ_DAQ
XCP Commands/DAQ and STIM Commands/SET_DAQ_LIST_MODE	true	tBool	Activates / Deactivates XCP command: SET_DAQ_LIST_MODE
XCP Commands/DAQ and STIM Commands/SET_DAQ_PTR	true	tBool	Activates / Deactivates XCP command: SET_DAQ_PTR
XCP Commands/DAQ and STIM Commands/START_STOP_DAQ_LIST	true	tBool	Activates / Deactivates XCP command: START_STOP_DAQ_LIST
XCP Commands/DAQ and STIM Commands/START_STOP_SYNCH	true	tBool	Activates / Deactivates XCP command: START_STOP_SYNCH
XCP Commands/DAQ and STIM Commands/WRITE_DAQ	true	tBool	Activates / Deactivates XCP command: WRITE_DAQ
XCP Commands/PAG Commands/COPY_CAL_PAGE	true	tBool	Activates / Deactivates XCP command: COPY_CAL_PAGE
XCP Commands/PAG Commands/GET_CAL_PAGE	true	tBool	Activates / Deactivates XCP command: GET_CAL_PAGE
XCP Commands/PAG Commands/GET_PAGE_INFO	true	tBool	Activates / Deactivates XCP command: GET_PAGE_INFO
XCP Commands/PAG Commands/GET_PAG_PROCESSOR_INFO	true	tBool	Activates / Deactivates XCP command: GET_PAG_PROCESSOR_INFO
XCP Commands/PAG Commands/GET_SEGMENT_INFO	true	tBool	Activates / Deactivates XCP command: GET_SEGMENT_INFO
XCP Commands/PAG Commands/GET_SEGMENT_MODE	true	tBool	Activates / Deactivates XCP command: GET_SEGMENT_MODE
XCP Commands/PAG Commands/SET_CAL_PAGE	true	tBool	Activates / Deactivates XCP command: SET_CAL_PAGE
XCP Commands/PAG Commands/SET_SEGMENT_MODE	true	tBool	Activates / Deactivates XCP command: SET_SEGMENT_MODE
XCP Commands/PGM Commands/GET_PGM_PROCESSOR_INFO	true	tBool	Activates / Deactivates XCP command: GET_PGM_PROCESSOR_INFO
XCP Commands/PGM Commands/GET_SECTOR_INFO	true	tBool	Activates / Deactivates XCP command: GET_SECTOR_INFO
XCP Commands/PGM Commands/PROGRAM	true	tBool	Activates / Deactivates XCP command: PROGRAM
XCP Commands/PGM Commands/PROGRAM_CLEAR	true	tBool	Activates / Deactivates XCP command: PROGRAM_CLEAR
XCP Commands/PGM Commands/PROGRAM_FORMAT	true	tBool	Activates / Deactivates XCP command: PROGRAM_FORMAT
XCP Commands/PGM Commands/PROGRAM_MAX	true	tBool	Activates / Deactivates XCP command: PROGRAM_MAX
XCP Commands/PGM Commands/PROGRAM_NEXT	true	tBool	Activates / Deactivates XCP command: PROGRAM_NEXT
XCP Commands/PGM Commands/PROGRAM_PREPARE	true	tBool	Activates / Deactivates XCP command: PROGRAM_PREPARE
XCP Commands/PGM Commands/PROGRAM_RESET	true	tBool	Activates / Deactivates XCP command: PROGRAM_RESET
XCP Commands/PGM Commands/PROGRAM_START	true	tBool	Activates / Deactivates XCP command: PROGRAM_START
XCP Commands/PGM Commands/PROGRAM_VERIFY	true	tBool	Activates / Deactivates XCP command: PROGRAM_VERIFY
XCP Commands/Standard Commands/BUILD_CHECKSUM	true	tBool	Activates / Deactivates XCP command: BUILD_CHECKSUM
XCP Commands/Standard Commands/CONNECT	true	tBool	Activates / Deactivates XCP command: CONNECT
XCP Commands/Standard Commands/DISCONNECT	true	tBool	Activates / Deactivates XCP command: DISCONNECT
XCP Commands/Standard Commands/GET_COMM_MODE_INFO	true	tBool	Activates / Deactivates XCP command: GET_COMM_MODE_INFO
XCP Commands/Standard Commands/GET_ID	true	tBool	Activates / Deactivates XCP command: GET_ID
XCP Commands/Standard Commands/GET_SEED	true	tBool	Activates / Deactivates XCP command: GET_SEED
XCP Commands/Standard Commands/GET_STATUS	true	tBool	Activates / Deactivates XCP command: GET_STATUS
XCP Commands/Standard Commands/SET_MTA	true	tBool	Activates / Deactivates XCP command: SET_MTA
XCP Commands/Standard Commands/SET_REQUEST	true	tBool	Activates / Deactivates XCP command: SET_REQUEST
XCP Commands/Standard Commands/SHORT_UPLOAD	true	tBool	Activates / Deactivates XCP command: SHORT_UPLOAD
XCP Commands/Standard Commands/SYNC	true	tBool	Activates / Deactivates XCP command: SYNC
XCP Commands/Standard Commands/TRANSPORT_LAYER_CMD	true	tBool	Activates / Deactivates XCP command: TRANSPORT_LAYER_CMD
XCP Commands/Standard Commands/UNLOCK	true	tBool	Activates / Deactivates XCP command: UNLOCK
XCP Commands/Standard Commands/UPLOAD	true	tBool	Activates / Deactivates XCP command: UPLOAD
XCP Commands/Standard Commands/USER_CMD	true	tBool	Activates / Deactivates XCP command: USER_CMD

Input Pins

Name	Stream Type	Description
slave_xcp_frames	adtf/calibtb/xcp_frames	Incoming XCP frames from an ECU
signal_writes	adtf/substreams	Incoming signal values that are written to the ECU (Substreams)

Output Pins

Name	Stream Type	Description
master_xcp_frames	adtf/calibtb/xcp_frames	Outgoing XCP frames to an ECU
record_xcp_frames	adtf/calibtb/xcp_frames	Can be used for recording all of the XCP communication between the master filter and the ECU
signal_updates	adtf/substreams	Signal values that have been read from the ECU (Substreams)

Runner

Name	Activation Type	Data Triggered	Data Input	Thread Triggered	Thread Cyclic	Timer Triggered	Timer Interval	Description
process_xcp_frames	9	1	slave_xcp_frames	0	0	0	0	Runner that process xcp frames from the ECU.
process_signal_writes	9	1	signal_writes	0	0	0	0	Default runner port for the input pin 'signal_writes'

Input Binding Objects

Name	IID	Proxy OID	Description
xcp_master	xcp_master.aconcagua.calibtb.adtf.iid		Binding Proxy connection necessary for 'XCP En - / Decode' - Filter

Dynamic Pins

Dynamic Input Pins	false
Dynamic Output Pins	false
Dynamic Input Binding Pins	false
Dynamic Output Binding Pins	false

Required Interfaces

IID
xcp_service.aconcagua.calibtb.adtf.iid
kernel.penguin.services.adtf.iid

Input Pin Stream Types

Pin Name	slave_xcp_frames
Meta Type Name	adtf/calibtb/xcp_frames
Stream Type Properties	Name Value Type Description Subproperties md_data_serialized false tBool md_definitions <struct name="tXcpFrame" alignment="1" version="1"> <element name="eDirection" type="tUInt32" arraysize="1"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="0"/> </element> <element name="tmReceiveTime" type="tInt64" arraysize="1"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="4"/> </element> <element name="ui16Counter" type="tUInt16" arraysize="1"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="12"/> </element> <element name="ui16Length" type="tUInt16" arraysize="1"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="14"/> </element> <element name="aui8Packet" type="tUInt8" arraysize="ui16Length"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="16"/> </element></struct> cString md_struct tXcpFrame cString xcp_config cString

Pin Name	signal_writes
Meta Type Name	adtf/substreams
Stream Type Properties	Name Value Type Description Subproperties substreams true tBool

Output Pin Stream Types

Pin Name	master_xcp_frames
Meta Type Name	adtf/calibtb/xcp_frames
Stream Type Properties	Name Value Type Description Subproperties md_data_serialized false tBool md_definitions <struct name="tXcpFrame" alignment="1" version="1"> <element name="eDirection" type="tUInt32" arraysize="1"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="0"/> </element> <element name="tmReceiveTime" type="tInt64" arraysize="1"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="4"/> </element> <element name="ui16Counter" type="tUInt16" arraysize="1"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="12"/> </element> <element name="ui16Length" type="tUInt16" arraysize="1"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="14"/> </element> <element name="aui8Packet" type="tUInt8" arraysize="ui16Length"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="16"/> </element></struct> cString md_struct tXcpFrame cString xcp_config cString

Pin Name	record_xcp_frames
Meta Type Name	adtf/calibtb/xcp_frames
Stream Type Properties	Name Value Type Description Subproperties md_data_serialized false tBool md_definitions <struct name="tXcpFrame" alignment="1" version="1"> <element name="eDirection" type="tUInt32" arraysize="1"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="0"/> </element> <element name="tmReceiveTime" type="tInt64" arraysize="1"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="4"/> </element> <element name="ui16Counter" type="tUInt16" arraysize="1"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="12"/> </element> <element name="ui16Length" type="tUInt16" arraysize="1"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="14"/> </element> <element name="aui8Packet" type="tUInt8" arraysize="ui16Length"> <deserialized alignment="1"/> <serialized byteorder="LE" bytepos="16"/> </element></struct> cString md_struct tXcpFrame cString xcp_config cString

Pin Name	signal_updates
Meta Type Name	adtf/substreams
Stream Type Properties	Name Value Type Description Subproperties substreams true tBool