Skip to content

Commit b6e55a7

Browse files
authored
xcplib update (#35)
* Updated xcplib to VectorGrp/XCPlite master
1 parent a9c89c4 commit b6e55a7

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

src/xcp/xcplib.rs

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,19 @@ unsafe extern "C" {
1818
}
1919
pub type tXcpEventId = u16;
2020
unsafe extern "C" {
21-
pub fn XcpEventExt(event: tXcpEventId, base: *const u8);
21+
#[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."]
22+
pub fn XcpEvent(event: tXcpEventId);
2223
}
2324
unsafe extern "C" {
24-
pub fn XcpEvent(event: tXcpEventId);
25+
#[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."]
26+
pub fn XcpEventExt(event: tXcpEventId, base: *const u8);
2527
}
2628
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)"]
29+
#[doc = " Set log level\n Log level 4 provides a trace of all XCP commands and responses.\n @param level (0 = no logging, 1 = error, 2 = warning, 3 = info, 4 = debug, 5 = trace)"]
2830
pub fn XcpSetLogLevel(level: u8);
2931
}
3032
unsafe extern "C" {
31-
#[doc = " Initialize the XCP singleton, must be called befor starting the server"]
33+
#[doc = " Initialize the XCP singleton, activate XCP, must be called before starting the server\n If XCP is not activated, the server will not start and all XCP instrumentation will be passive with minimal overhead\n @param activate If true, the XCP library is activated"]
3234
pub fn XcpInit(activate: bool);
3335
}
3436
unsafe extern "C" {
@@ -42,15 +44,15 @@ unsafe extern "C" {
4244
pub fn XcpDisconnect();
4345
}
4446
unsafe extern "C" {
45-
#[doc = " Send terminate session event to the XCP client"]
47+
#[doc = " Send terminate session event to the XCP client\n Force the XCP client to terminate the session"]
4648
pub fn XcpSendTerminateSessionEvent();
4749
}
4850
unsafe extern "C" {
49-
#[doc = " Send a message to the XCP client"]
51+
#[doc = " Send a message to the XCP client\n @param str Message to send, appears in the XCP client write log window"]
5052
pub fn XcpPrint(str_: *const ::std::os::raw::c_char);
5153
}
5254
unsafe extern "C" {
53-
#[doc = " Get the current DAQ clock value\n @return time in CLOCK_TICKS_PER_S units"]
55+
#[doc = " Get the current DAQ clock value\n @return time in CLOCK_TICKS_PER_S units\n Resolution and epoch is defined in main_cfg.h\n Epoch may be PTP or arbitrary\n Resolution is 1ns or 1us"]
5456
pub fn ApplXcpGetClock64() -> u64;
5557
}
5658
unsafe extern "C" {

xcplib

Submodule xcplib updated 52 files

0 commit comments

Comments
 (0)