Collaboration diagram for TraceLib:

Trace Functions

Description

This function group provides access to the common internal tracing module of the device.

The tracing system provides a mechanism for collecting and viewing device debug output. Logs from various components and the firmware system are collected in a circular buffer, which then can be read and viewed. There are 3 types of logs in the trace system:

Message,
Warning and
Error.

For better filtering and to minimize performance impact on the running system, the logs can be grouped to modules and each module can be activated or deactivated. A log to a activated module is written to one of the given circular buffers of the trace system. Logs to deactivated modules are discarded. It is possible to read the current content of the buffers.

More Information

For more information, refer to mlpiCore documentation: TraceLib.

Copyright

m4MTraceActivateAllModules

Trace-Function: Activate all trace modules.

Description

This function activates all available trace modules.

Note: Enabling all trace modules might result in a performance drop, as tracing costs CPU time. It is not recommended to enable all trace modules on a productive machine. Try activating only the modules of interest or one module at a time.

Syntax

m4MTraceActivateAllModules(connection)
result = m4MTraceActivateAllModules(connection)

Input Arguments

connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.

Output Arguments

result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Example Files

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:

m4MTraceActivateAllModules_Sample.m

Reference to mlpiCore

This function maps to the mlpiCore function: mlpiTraceActivateAllModules

Copyright

m4MTraceClearAllBuffers

Trace-Function: Clear all trace buffers.

Description

This function clears all buffers. This means that all trace messages currently available and stored in the system will be deleted.

Syntax

m4MTraceClearAllBuffers(connection)
result = m4MTraceClearAllBuffers(connection)

Input Arguments

connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.

Output Arguments

result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Example Files

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:

m4MTraceClearAllBuffers_Sample.m

Reference to mlpiCore

This function maps to the mlpiCore function: mlpiTraceClearAllBuffers

Copyright

m4MTraceDeactivateAllModules

Trace-Function: Deactivate all trace modules.

Description

This function deactivates all available trace modules.

Syntax

m4MTraceDeactivateAllModules(connection)
result = m4MTraceDeactivateAllModules(connection)

Input Arguments

connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.

Output Arguments

result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Example Files

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:

m4MTraceDeactivateAllModules_Sample.m

Reference to mlpiCore

This function maps to the mlpiCore function: mlpiTraceDeactivateAllModules

Copyright

Trace Functions

Description

More Information

m4MTraceActivateAllModules

m4MTraceActivateAllModules

Description

Syntax

Input Arguments

Output Arguments

Example Files

See also

Reference to mlpiCore

m4MTraceClearAllBuffers

m4MTraceClearAllBuffers

Description

Syntax

Input Arguments

Output Arguments

Example Files

See also

Reference to mlpiCore

m4MTraceDeactivateAllModules

m4MTraceDeactivateAllModules

Description

Syntax

Input Arguments

Output Arguments

Example Files

See also

Reference to mlpiCore