adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

doc: services: document sys_trace_user_event

Browse source 
Document availability of sys_trace_user_event, for users who are trying
to add custom trace events to their application.

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
This commit is contained in:
Daniel DeGrasse 2024-06-10 19:56:47 +00:00 committed by Anas Nashif
parent 66577a9d23
commit 87180f40ac
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/services/tracing/index.rst
View file

@ -32,6 +32,18 @@ interface between payload/format (Top Layer) and the transport mechanics
(bottom Layer) is generic and efficient enough to model these. See the
*I/O taxonomy* section below.
Named Trace Events
******************
Although the user can extend any of the supported serialization formats
to enable additional tracing functions (or provide their own backend), zephyr
also provides one generic named tracing function for convenience purposes,
as well as to demonstrate how tracing frameworks could be extended.
Users can generate a custom trace event by calling
:c:func:`sys_tracing_named_event`, which takes an event name as well as two
arbitrary 4 byte arguments. Tracing backends may truncate the provided event
name if it is too long for the serialization format they support.
Serialization Formats
**********************