V0.9.2 (#33)

RainerZ · web-flow · commit a9c89c4d7f24 · 2025-07-14T20:44:28.000+02:00
* Updated xcplib (XCPlite) to V0.9.2
diff --git a/README.md b/README.md
@@ -1,22 +1,9 @@
 # xcp-lite
 
-XCP for Rust - based on XCPlite (https://github.com/vectorgrp/XCPlite)  
+XCP for Rust - based on XCPlite (<https://github.com/vectorgrp/XCPlite>)  
   
 Disclaimer: This code is in experimental state. There is no release yet.  
-
-Note: This repo contains a newer version of XCPlite (in folder xcplib).  
-This version is not released yet.  
-
-* Breaking changes to V6.
-* Compiles as C11.  
-* Lockless transmit queue. Works on x86-64 strong and ARM-64 weak memory model.  
-* Measurement of and write access to variables on stack.  
-* Supports multiple calibration segments with working and reference page with independent page switching.  
-* Lock free and thread safe calibration parameter access, consistent calibration changes and page switches.  
-* More C examples.   
-* Build as a library.  
-* Used (as FFI library) for the rust xcp-lite version.
-
+Note: This repo refers to an unreleased version of XCPlite as a submodule (in folder xcplib, currently V0.9.2).  
 
 xcp-lite is a Rust API for measurement and calibration, which uses the ASAM XCP protocol for communication with a measurement and calibration tool like CANape and ASAM A2L for data description.  
 
@@ -114,23 +101,21 @@ Demonstrates using XCP in an async tokio based application
 Measure a lidar point cloud and visualize it in CANapes 3D scene window  
 Use CDR serialization over XCP and the CDR/IDL schema generator proc-macro
 
-
 ## Code instrumentation for measurement and calibration
   
 There are 3 important types: Xcp, XcpEvent/DaqEvent and CalSeg.  
 Xcp is a wrapper for XCPlite. It is a singleton. There is a builder to initialize the XCP server or ethernet transport layer.
   
 CalSeg is a generic type used to encapsulate structs containing calibration parameters. This is called a calibration segment and the parameter struct wrapped is a calibration page. A calibration page must be Copy and may contain nested structs of basic types or arrays with dimension up to 2.  
   
-A CalSeg has interior mutability. Parameter mutation happens only on acquiring a calibration segment guard.   
+A CalSeg has interior mutability. Parameter mutation happens only on acquiring a calibration segment guard.
   
 A CalSeg may be shared among multiple threads. It it cloned like an Arc, implements the Deref trait for convenience and does not do any locks to deref to the inner calibration parameter page struct.
 
 Measurement code instrumentation provides event definition, registration or capture of measurement objects. Measurement objects can be captured (copied to a buffer inside the event) or accessed directly on stack memory after being registered. Capture works for variables on heap or stack. Measurement variables can be registered as single instance or multi instance, which creates one variable instance for each thread instance. Variable names and event names are automatically extended with an index in this case.
 
 The registration of objects has to be completed, before the A2L file is generated. The A2L is created at latest on connect of the XCP client tool. Objects created later, will not be visible to CANape.  
   
-
 ## Safety Considerations
 
 The fundamental functional concept of this XCP implementation is, to mutate the calibration variables in their original binary representation in a thread safe, transparent wrapper type.  
@@ -190,7 +175,6 @@ Feature a2l_reader is needed for xcp_client based testing
 
 Use --nocapture because the debug output from the XCPlite C library is via normal printf
 
-
 ## Notes
 
 All measurement and calibration code instrumentation is non blocking and the trigger event and sync methods is optimized for speed and minimal locking.  
diff --git a/build.rs b/build.rs
@@ -62,6 +62,9 @@ fn main() {
         .file("xcplib/src/xcpQueue32.c")
         .file("xcplib/src/xcpEthTl.c")
         .file("xcplib/src/xcpEthServer.c");
+
+    builder.define("XCPLIB_FOR_RUST", None);
+
     if is_posix {
         //builder.define("_POSIX_C_SOURCE", "200112L");
         builder.flag("-std=c11");
diff --git a/src/xcp/mod.rs b/src/xcp/mod.rs
@@ -337,7 +337,7 @@ impl Xcp {
         unsafe {
             // Initialize the XCP protocol layer
             // @@@@ UNSAFE - C library calls
-            xcplib::XcpInit();
+            xcplib::XcpInit(true);
 
             // Register the callbacks from xcplib
             // @@@@ UNSAFE - C library calls
diff --git a/src/xcp/xcplib.rs b/src/xcp/xcplib.rs
@@ -24,10 +24,12 @@ unsafe extern "C" {
     pub fn XcpEvent(event: tXcpEventId);
 }
 unsafe extern "C" {
+    #[doc = " Set log level\n @param log level (0 = no logging, 1 = error, 2 = warning, 3 = info, 4 = debug, 5 = trace)"]
     pub fn XcpSetLogLevel(level: u8);
 }
 unsafe extern "C" {
-    pub fn XcpInit();
+    #[doc = " Initialize the XCP singleton, must be called befor starting the server"]
+    pub fn XcpInit(activate: bool);
 }
 unsafe extern "C" {
     pub fn ApplXcpSetA2lName(name: *const ::std::os::raw::c_char);
@@ -36,15 +38,19 @@ unsafe extern "C" {
     pub fn XcpSetEpk(epk: *const ::std::os::raw::c_char);
 }
 unsafe extern "C" {
+    #[doc = " Force Disconnect\n Stop DAQ, flush queue, flush pending calibrations"]
     pub fn XcpDisconnect();
 }
 unsafe extern "C" {
+    #[doc = " Send terminate session event to the XCP client"]
     pub fn XcpSendTerminateSessionEvent();
 }
 unsafe extern "C" {
+    #[doc = " Send a message to the XCP client"]
     pub fn XcpPrint(str_: *const ::std::os::raw::c_char);
 }
 unsafe extern "C" {
+    #[doc = " Get the current DAQ clock value\n @return time in CLOCK_TICKS_PER_S units"]
     pub fn ApplXcpGetClock64() -> u64;
 }
 unsafe extern "C" {
diff --git a/xcp_lite.a2l b/xcp_lite.a2l
@@ -79,7 +79,7 @@
             /begin TYPEDEF_CHARACTERISTIC C_I64 "" VALUE I64 0 NO_COMPU_METHOD -1e12 1e12 /end TYPEDEF_CHARACTERISTIC
             /begin TYPEDEF_CHARACTERISTIC C_F64 "" VALUE F64 0 NO_COMPU_METHOD -1e12 1e12 /end TYPEDEF_CHARACTERISTIC
             /begin TYPEDEF_CHARACTERISTIC C_F32 "" VALUE F32 0 NO_COMPU_METHOD -1e12 1e12 /end TYPEDEF_CHARACTERISTIC
-            /begin MOD_PAR "" EPK "2025-07-04 12:36:58Z" ADDR_EPK 0x80000000
+            /begin MOD_PAR "" EPK "2025-07-14 18:35:27Z" ADDR_EPK 0x80000000
 /begin MEMORY_SEGMENT epk "" DATA FLASH INTERN 0x80000000 20 -1 -1 -1 -1 -1 /end MEMORY_SEGMENT
 /begin MEMORY_SEGMENT calseg "" DATA FLASH INTERN 0x80010000 8 -1 -1 -1 -1 -1
 /begin IF_DATA XCP
@@ -149,7 +149,7 @@
                 0x1 SIZE_DWORD UNIT_1US TIMESTAMP_FIXED
             /end TIMESTAMP_SUPPORTED
             
-/begin EVENT "main" "main" 10 DAQ 0xFF 0 0 0 CONSISTENCY DAQ /end EVENT
+/begin EVENT "main" "main" 11 DAQ 0xFF 0 0 0 CONSISTENCY DAQ /end EVENT
 /begin EVENT "main_local" "main_local" 13 DAQ 0xFF 0 0 0 CONSISTENCY DAQ /end EVENT
 /begin EVENT "main_task1" "main_task1" 12 DAQ 0xFF 0 0 0 CONSISTENCY DAQ /end EVENT
 /begin EVENT "main_task2_1" "main_task2_1" 0 DAQ 0xFF 0 0 0 CONSISTENCY DAQ /end EVENT
@@ -161,7 +161,7 @@
 /begin EVENT "main_task2_7" "main_task2_7" 7 DAQ 0xFF 0 0 0 CONSISTENCY DAQ /end EVENT
 /begin EVENT "main_task2_8" "main_task2_8" 8 DAQ 0xFF 0 0 0 CONSISTENCY DAQ /end EVENT
 /begin EVENT "main_task2_9" "main_task2_9" 9 DAQ 0xFF 0 0 0 CONSISTENCY DAQ /end EVENT
-/begin EVENT "main_task2_10" "main_task2_10" 11 DAQ 0xFF 0 0 0 CONSISTENCY DAQ /end EVENT
+/begin EVENT "main_task2_10" "main_task2_10" 10 DAQ 0xFF 0 0 0 CONSISTENCY DAQ /end EVENT
 /begin EVENT "main_task2s" "main_task2s" 1 DAQ 0xFF 0 0 0 CONSISTENCY DAQ /end EVENT
 
 			/end DAQ
@@ -258,7 +258,7 @@
 /begin MEASUREMENT channel_7 "sine: f64" FLOAT64_IEEE NO_COMPU_METHOD 0 0 -100000000000000000000000000000000 100000000000000000000000000000000 ECU_ADDRESS 0x0 ECU_ADDRESS_EXTENSION 3 PHYS_UNIT "Volt" /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 7 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
 /begin MEASUREMENT channel_8 "sine: f64" FLOAT64_IEEE NO_COMPU_METHOD 0 0 -100000000000000000000000000000000 100000000000000000000000000000000 ECU_ADDRESS 0x0 ECU_ADDRESS_EXTENSION 3 PHYS_UNIT "Volt" /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 8 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
 /begin MEASUREMENT channel_9 "sine: f64" FLOAT64_IEEE NO_COMPU_METHOD 0 0 -100000000000000000000000000000000 100000000000000000000000000000000 ECU_ADDRESS 0x0 ECU_ADDRESS_EXTENSION 3 PHYS_UNIT "Volt" /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 9 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
-/begin MEASUREMENT channel_10 "sine: f64" FLOAT64_IEEE NO_COMPU_METHOD 0 0 -100000000000000000000000000000000 100000000000000000000000000000000 ECU_ADDRESS 0x0 ECU_ADDRESS_EXTENSION 3 PHYS_UNIT "Volt" /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 11 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
+/begin MEASUREMENT channel_10 "sine: f64" FLOAT64_IEEE NO_COMPU_METHOD 0 0 -100000000000000000000000000000000 100000000000000000000000000000000 ECU_ADDRESS 0x0 ECU_ADDRESS_EXTENSION 3 PHYS_UNIT "Volt" /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 10 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
 /begin MEASUREMENT counter "" ULONG IDENTITY 0 0 0 4294967295 ECU_ADDRESS 0xFFFFF7B8 ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 12 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
 /begin MEASUREMENT counter_i16 "counter: i16" SWORD IDENTITY 0 0 -32768 32767 ECU_ADDRESS 0xFFFFF7C2 ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 12 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
 /begin MEASUREMENT counter_i32 "counter: i32" SLONG IDENTITY 0 0 -2147483648 2147483647 ECU_ADDRESS 0xFFFFF7C8 ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 12 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
@@ -271,14 +271,14 @@
 /begin MEASUREMENT counter_u64 "counter: u64" A_UINT64 IDENTITY 0 0 0 18446744073709552000 ECU_ADDRESS 0xFFFFF7CC ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 12 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
 /begin MEASUREMENT counter_u8 "counter: u8" UBYTE IDENTITY 0 0 0 255 ECU_ADDRESS 0xFFFFF7BE ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 12 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
 /begin MEASUREMENT counter_usize "counter: u64" A_UINT64 IDENTITY 0 0 0 18446744073709552000 ECU_ADDRESS 0xFFFFF7DC ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 12 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
-/begin MEASUREMENT mainloop_counter1 "" A_UINT64 IDENTITY 0 0 0 18446744073709552000 ECU_ADDRESS 0xFFFFFFBC ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 10 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
+/begin MEASUREMENT mainloop_counter1 "" A_UINT64 IDENTITY 0 0 0 18446744073709552000 ECU_ADDRESS 0xFFFFFFBC ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 11 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
 /begin COMPU_METHOD mainloop_local_var1 "" LINEAR "%.3" "no unit" COEFFS_LINEAR 0.5 10000000 /end COMPU_METHOD
-/begin MEASUREMENT mainloop_local_var1 "test local variable with conversion rule" A_UINT64 mainloop_local_var1 0 0 10000000 9223372036864776000 ECU_ADDRESS 0x1C ECU_ADDRESS_EXTENSION 3 PHYS_UNIT "no unit" /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 10 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
+/begin MEASUREMENT mainloop_local_var1 "test local variable with conversion rule" A_UINT64 mainloop_local_var1 0 0 10000000 9223372036864776000 ECU_ADDRESS 0x1C ECU_ADDRESS_EXTENSION 3 PHYS_UNIT "no unit" /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 11 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
 /begin COMPU_METHOD mainloop_local_var2 "" LINEAR "%.0" "no unit" COEFFS_LINEAR 2 -10000000 /end COMPU_METHOD
 /begin MEASUREMENT mainloop_local_var2 "test local variable with conversion rule" A_UINT64 mainloop_local_var2 0 0 -10000000 36893488147409105000 ECU_ADDRESS 0xFFFFFFEC ECU_ADDRESS_EXTENSION 3 PHYS_UNIT "no unit" /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 13 /end DAQ_EVENT /end IF_DATA /end MEASUREMENT
-/begin INSTANCE mainloop_struct "" TestNestedStruct 0xFFFFFFC4 ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 10 /end DAQ_EVENT /end IF_DATA /end INSTANCE
-/begin INSTANCE mainloop_struct1 "" TestStruct 0xFFFFFF24 ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 10 /end DAQ_EVENT /end IF_DATA /end INSTANCE
-/begin INSTANCE mainloop_struct2 "" TestStruct 0xFFFFFF44 ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 10 /end DAQ_EVENT /end IF_DATA /end INSTANCE
+/begin INSTANCE mainloop_struct "" TestNestedStruct 0xFFFFFFC4 ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 11 /end DAQ_EVENT /end IF_DATA /end INSTANCE
+/begin INSTANCE mainloop_struct1 "" TestStruct 0xFFFFFF24 ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 11 /end DAQ_EVENT /end IF_DATA /end INSTANCE
+/begin INSTANCE mainloop_struct2 "" TestStruct 0xFFFFFF44 ECU_ADDRESS_EXTENSION 3 /begin IF_DATA XCP /begin DAQ_EVENT FIXED_EVENT_LIST EVENT 11 /end DAQ_EVENT /end IF_DATA /end INSTANCE
 /begin GROUP Measurements "" ROOT /begin SUB_GROUP main main_local main_task1 main_task2 main_task2s /end SUB_GROUP /end GROUP
 /begin GROUP main "" /begin REF_MEASUREMENT mainloop_counter1 mainloop_local_var1 mainloop_struct mainloop_struct1 mainloop_struct2 /end REF_MEASUREMENT /end GROUP
 /begin GROUP main_local "" /begin REF_MEASUREMENT mainloop_local_var2 /end REF_MEASUREMENT /end GROUP
diff --git a/xcplib b/xcplib
@@ -1 +1 @@
-Subproject commit e4b1d4363bbcada51a7462964179c44cdfdaea5a
+Subproject commit de996b3d23e0dc2f4b9e64a9b59a65d08a435b8d

Original file line number	Diff line number	Diff line change
`@@ -24,10 +24,12 @@ unsafe extern "C" {`
`24`	`24`	`pub fn XcpEvent(event: tXcpEventId);`
`25`	`25`	`}`
`26`	`26`	`unsafe extern "C" {`
	`27`	`+ #[doc = " Set log level\n @param log level (0 = no logging, 1 = error, 2 = warning, 3 = info, 4 = debug, 5 = trace)"]`
`27`	`28`	`pub fn XcpSetLogLevel(level: u8);`
`28`	`29`	`}`
`29`	`30`	`unsafe extern "C" {`
`30`		`- pub fn XcpInit();`
	`31`	`+ #[doc = " Initialize the XCP singleton, must be called befor starting the server"]`
	`32`	`+ pub fn XcpInit(activate: bool);`
`31`	`33`	`}`
`32`	`34`	`unsafe extern "C" {`
`33`	`35`	`pub fn ApplXcpSetA2lName(name: *const ::std::os::raw::c_char);`
`@@ -36,15 +38,19 @@ unsafe extern "C" {`
`36`	`38`	`pub fn XcpSetEpk(epk: *const ::std::os::raw::c_char);`
`37`	`39`	`}`
`38`	`40`	`unsafe extern "C" {`
	`41`	`+ #[doc = " Force Disconnect\n Stop DAQ, flush queue, flush pending calibrations"]`
`39`	`42`	`pub fn XcpDisconnect();`
`40`	`43`	`}`
`41`	`44`	`unsafe extern "C" {`
	`45`	`+ #[doc = " Send terminate session event to the XCP client"]`
`42`	`46`	`pub fn XcpSendTerminateSessionEvent();`
`43`	`47`	`}`
`44`	`48`	`unsafe extern "C" {`
	`49`	`+ #[doc = " Send a message to the XCP client"]`
`45`	`50`	`pub fn XcpPrint(str_: *const ::std::os::raw::c_char);`
`46`	`51`	`}`
`47`	`52`	`unsafe extern "C" {`
	`53`	`+ #[doc = " Get the current DAQ clock value\n @return time in CLOCK_TICKS_PER_S units"]`
`48`	`54`	`pub fn ApplXcpGetClock64() -> u64;`
`49`	`55`	`}`
`50`	`56`	`unsafe extern "C" {`