xcp_client TCP support and improvement to test XCPlite GET_SEGMENT_INFO (#37)

* Update to XCPlite xcplib master
* Updated xcplib (XCPlite) to VectorGrp master
* GET_SEGMENT_INFO, GET_DAQ_EVENT_INFO
* Read event and segment info from XCP server
* Option --read_a2l
* xcp_client TCP support

Author: RainerZ

Cargo.toml

@@ -154,6 +154,10 @@ regex = "1.11.1"
 tokio = { version = "1.37.0", features = ["full"] }
 xcp_client = { path = "xcp_client" }
 
+#goblin = "0.8"
+#gimli = "0.28"
+
+
 # A2L checker (optional)
 a2lfile = { version="3.0.0", optional = false}
 

README.md

@@ -170,7 +170,6 @@ Feature a2l_reader is needed for xcp_client based testing
 ```
   cargo test --features=a2l_reader  -- --test-threads=1 --nocapture
   cargo test --features=a2l_reader  -- --test-threads=1 --nocapture  --test test_multi_thread
-  cargo test --features=shm_mode  -- --test-threads=1 --nocapture  --test test_performance
 ```
 
 Use --nocapture because the debug output from the XCPlite C library is via normal printf

build.rs

@@ -18,11 +18,12 @@ fn main() {
     // Generate C code bindings for xcplib
     if is_posix {
         let bindings = bindgen::Builder::default()
-            .header("xcplib/src/xcplib.h")
+            .header("xcplib/inc/xcplib.h")
             //
             //.clang_args(&["-target", "x86_64-pc-windows-msvc"])
             .clang_arg("-Ixcplib/src")
             .clang_arg("-Ixcplib")
+            .clang_arg("-DXCPLIB_FOR_RUST")
             .parse_callbacks(Box::new(bindgen::CargoCallbacks::new()))
             //
             .blocklist_type("T_CLOCK_INFO")

src/registry/a2l/a2l_reader.rs

@@ -326,7 +326,6 @@ fn registry_load_a2lfile(registry: &mut Registry, a2l_file: &a2lfile::A2lFile) -
     // Memory segments
 
     // Add memory segments and EPK
-    let mut index = 0;
     if let Some(mod_par) = &module.mod_par {
         // EPK
         if let Some(epk) = &mod_par.epk {
@@ -337,20 +336,23 @@ fn registry_load_a2lfile(registry: &mut Registry, a2l_file: &a2lfile::A2lFile) -
         }
 
         // Memory segments
+        let mut index = 0;
+        let mut number: u8 = 0; // Number is part of the memory segment IF_DATA, not used here
         for m in mod_par.memory_segment.iter() {
             let name = m.get_name().to_string();
             let addr_ext = 0; // @@@@ xcp-lite address extensions hardcoded here, would be in IF_DATA
             let addr = m.address;
             let size = m.size;
             if vector_xcp_mode {
+                // Get index from addr, in vector mode the high word of the segment address is the segment number
+                let addr_index = ((addr >> 16) & 0x7FFF) as u16;
+                assert!(number as u16 == addr_index);
+
                 if name == "epk" {
-                    // Predefined memory segment for EPK, just ignore
+                    // Predefined memory segment for EPK, just ignore, don't increment index
+                    number += 1;
                     continue;
                 }
-                // Get index from addr
-                index = ((addr >> 16) & 0x7FFF) as u16 - 1; // EPK segment is virtual, index starts with 0
-            } else {
-                index += 1; // Index starts with 1, 0 is predefined EPK segment
             }
 
             let res = registry.cal_seg_list.add_a2l_cal_seg(name, index, addr_ext, addr, size);
@@ -360,6 +362,9 @@ fn registry_load_a2lfile(registry: &mut Registry, a2l_file: &a2lfile::A2lFile) -
                     warn!("Failed to add calibration segment: {}", e);
                 }
             }
+
+            index += 1;
+            number += 1;
         }
     }
 

src/registry/mc_support.rs

@@ -173,7 +173,7 @@ impl Default for McSupportData {
 
 impl Clone for McSupportData {
     fn clone(&self) -> Self {
-        log::debug!("Cloning McSupportData");
+        log::trace!("Cloning McSupportData");
         McSupportData {
             object_type: self.object_type,
             qualifier: self.qualifier,

src/registry/mc_text.rs

@@ -81,7 +81,7 @@ impl From<McText> for String {
 impl From<Option<&String>> for McText {
     fn from(s: Option<&String>) -> Self {
         if let Some(s) = s {
-            log::debug!("From<String> to McText: Leak String '{s}' to &'static str");
+            log::trace!("From<String> to McText: Leak String '{s}' to &'static str");
             let s = s.clone().into_boxed_str();
             let s = Box::leak(s);
 
@@ -94,7 +94,7 @@ impl From<Option<&String>> for McText {
 
 impl From<&String> for McText {
     fn from(s: &String) -> Self {
-        log::debug!("From<String> to McText: Leak String '{s}' to &'static str");
+        log::trace!("From<String> to McText: Leak String '{s}' to &'static str");
         let s = s.clone().into_boxed_str();
         let s = Box::leak(s);
 
@@ -104,7 +104,7 @@ impl From<&String> for McText {
 
 impl From<String> for McText {
     fn from(s: String) -> Self {
-        log::debug!("From<String> to McText: Leak String '{s}' to &'static str");
+        log::trace!("From<String> to McText: Leak String '{s}' to &'static str");
         let s = s.into_boxed_str();
         let s = Box::leak(s);
 
@@ -228,7 +228,7 @@ fn check_identifier(s: &str) -> bool {
 
 impl From<String> for McIdentifier {
     fn from(s: String) -> Self {
-        log::debug!("From<String> to McIdentifier: Leak String '{s}' to &'static str");
+        log::trace!("From<String> to McIdentifier: Leak String '{s}' to &'static str");
         let mut s = s.clone();
         to_identifier(&mut s);
         let s = s.into_boxed_str();

src/xcp/xcplib.rs

@@ -18,11 +18,11 @@ unsafe extern "C" {
 }
 pub type tXcpEventId = u16;
 unsafe extern "C" {
-    #[doc = " Trigger the XCP event 'event' for stack relative or absolute addressing\n @param event Event id.\n Assumes XCP address extension XCP_ADDR_EXT_REL is used for stack relative addressing and XCP_ADDR_EXT_ABS for absolute addressing."]
+    #[doc = " Trigger the XCP event 'event' for stack absolute addressing mode (XCP_ADDR_EXT_ABS)\n @param event Event id.\n Assumes XCP address extension XCP_ADDR_EXT_REL is used for stack relative addressing and XCP_ADDR_EXT_ABS for absolute addressing."]
     pub fn XcpEvent(event: tXcpEventId);
 }
 unsafe extern "C" {
-    #[doc = " Trigger the XCP event 'event' for stack relative or absolute addressing and with explicitly given base address for relative addressing mode (DYN)\n @param event\n @param base address pointer for the relative (XCP_ADDR_EXT_DYN) addressing mode (from A2lSetRelativeAddrMode(base)).\n Assumes XCP_ADDR_EXT_REL is used for stack relative addressing and XCP_ADDR_EXT_ABS for absolute addressing."]
+    #[doc = " Trigger the XCP event 'event' for relative or absolute addressing mode with explicitly given base address (XCP_ADDR_EXT_DYN)\n @param event\n @param base address pointer for the relative (XCP_ADDR_EXT_DYN) addressing mode"]
     pub fn XcpEventExt(event: tXcpEventId, base: *const u8);
 }
 unsafe extern "C" {

tests/xcp_test_executor.rs

@@ -631,7 +631,7 @@ pub async fn test_setup(task_count: usize, load_a2l: bool, upload_a2l: bool) ->
     let local_addr = "0.0.0.0:0".parse().unwrap();
     info!("  dest_addr: {}", dest_addr);
     info!("  local_addr: {}", local_addr);
-    let mut xcp_client = XcpClient::new(dest_addr, local_addr);
+    let mut xcp_client = XcpClient::new(false, dest_addr, local_addr);
     let daq_decoder: Arc<parking_lot::lock_api::Mutex<parking_lot::RawMutex, DaqDecoder>> = Arc::new(Mutex::new(DaqDecoder::new(task_count)));
     let serv_text_decoder = ServTextDecoder::new();
     xcp_client.connect(Arc::clone(&daq_decoder), serv_text_decoder).await.unwrap();
@@ -679,7 +679,7 @@ pub async fn test_setup(task_count: usize, load_a2l: bool, upload_a2l: bool) ->
     if load_a2l {
         // Upload A2L file from XCP server
         if upload_a2l {
-            xcp_client.a2l_loader().await.unwrap();
+            xcp_client.a2l_loader("test").await.unwrap();
         }
         // Load the A2L file from file
         else {

xcp_client/Cargo.toml

@@ -25,6 +25,9 @@ byteorder = "1.5.0"
 regex = "1.11.1"
 lazy_static = "1.4"
 
+#goblin = "0.8"
+#gimli = "0.28"
+
 a2lfile = { version="3.0.0" }
 xcp_lite = { path = "../", features = ["a2l_reader"] }
 

xcp_client/README.md

@@ -24,6 +24,8 @@ Options:
           Lists all measurement variables
       --list-cal
           Lists all calibration variables
+      --cal `<NAME>` `<VALUE>`
+          Set calibration variable to a value (format: "variable_name value")
   -m, --measurement-list <MEASUREMENT_LIST>...
           Specifies the variables names for DAQ measurement, 'all' or a list of names separated by space
   -a, --a2l-filename <A2L_FILENAME>
@@ -33,6 +35,27 @@ Options:
   -V, --version
           Print version
 
+## Examples
+
+### List calibration variables
+
+```bash
+cargo run --example=xcp_client -- --list-cal ".*"
+```
+
+### Set a calibration variable
+
+```bash
+cargo run --example=xcp_client -- --cal variable_name 42.5
+```
+
+### Measure variables
+
+```bash
+cargo run --example=xcp_client -- -m ".*" -t 5000
+```
+
+
 
 
   ``` rust
@@ -71,5 +94,4 @@ Options:
     // Disconnect
     xcp_client.disconnect().await?);
 
-
    ```