X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=ucs2-lib%2Fdoc%2Fhtml%2Fgroup___g___u_c_s___t_r_a_c_e.html;fp=ucs2-lib%2Fdoc%2Fhtml%2Fgroup___g___u_c_s___t_r_a_c_e.html;h=4847d75aadfcaa6234c259c55fde3b0e134f09f3;hb=d2e42029ec04c3f224580f8007cdfbbfe0fc47a6;hp=0000000000000000000000000000000000000000;hpb=18e393e1443fd4c38b34979888fb55d30448cf31;p=apps%2Fagl-service-unicens.git diff --git a/ucs2-lib/doc/html/group___g___u_c_s___t_r_a_c_e.html b/ucs2-lib/doc/html/group___g___u_c_s___t_r_a_c_e.html new file mode 100644 index 0000000..4847d75 --- /dev/null +++ b/ucs2-lib/doc/html/group___g___u_c_s___t_r_a_c_e.html @@ -0,0 +1,152 @@ + + + + + +UNICENS: Tracing/Debugging + + + + + + + + + + + + + + + +
+
+
+ + + + + + + +
Logo +
UNICENS V2.1.0-3491
+
User Manual and API Reference
+ +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Topics | +Macros | +Callback Functions
+
+
Tracing/Debugging
+
Initialization and Service
+
+ +

Tracing/Debugging Interface. +More...

+ + + + + +

+Topics

 Tracing/Debugging Types
 Referred types used by Tracing/Debugging Interface.
 
+ + + + + + + + + + +

+Macros

#define UCS_TR_INFO
 Trace macro to capture trace info events.
 
#define UCS_TR_ERROR
 Trace macro to capture trace error events.
 
#define UCS_TR_SIZE_BUFFER   256
 Defines the needed buffer size to decode a trace entry.
 
+ + + + +

+Callback Functions

typedef void(* Ucs_DebugErrorMsgCb_t )(Msg_MostTel_t *msg_ptr, void *user_ptr)
 Optional callback function used to debug received raw messages with OpType UCS_OP_ERROR and UCS_OP_ERRORACK.
 
+

Detailed Description

+

Tracing/Debugging Interface.

+

The UCS Trace Interface is intended for debugging and logging purpose. There are 2 different trace options:

+
    +
  • The definition of trace macros to print out internal states, messages and errors. This option provides two trace classes: info and error. Each trace class can be activated by defining the respective macro UCS_TR_INFO UCS_TR_ERROR in the configuration header file ucs_cfg.h. While the info class is intended only for debugging purpose during development, the error class can also be active for logging purpose in a production system.
    • +
  • Implementation of the callback function Ucs_DebugErrorMsgCb_t which is assigned during initialization. The callback function is fired on every received Error message from a local or remote INIC.
    • +
+
+
+ + + + + +