zephyr/samples/subsys/tracing
Gerard Marull-Paretas 79e6b0e0f6 includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h>
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>.
This patch proposes to then include <zephyr/kernel.h> instead of
<zephyr/zephyr.h> since it is more clear that you are including the
Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a
catch-all header that may be confusing. Most applications need to
include a bunch of other things to compile, e.g. driver headers or
subsystem headers like BT, logging, etc.

The idea of a catch-all header in Zephyr is probably not feasible
anyway. Reason is that Zephyr is not a library, like it could be for
example `libpython`. Zephyr provides many utilities nowadays: a kernel,
drivers, subsystems, etc and things will likely grow. A catch-all header
would be massive, difficult to keep up-to-date. It is also likely that
an application will only build a small subset. Note that subsystem-level
headers may use a catch-all approach to make things easier, though.

NOTE: This patch is **NOT** removing the header, just removing its usage
in-tree. I'd advocate for its deprecation (add a #warning on it), but I
understand many people will have concerns.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-09-05 16:31:47 +02:00
..
boards
src includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h> 2022-09-05 16:31:47 +02:00
CMakeLists.txt
README.txt
prj.conf
prj_native_posix.conf
prj_native_posix_ctf.conf
prj_sysview.conf
prj_uart.conf
prj_uart_ctf.conf
prj_usb.conf
prj_usb_ctf.conf
prj_user.conf
sample.yaml samples: Add name "sample" in the some samples modules 2022-08-29 07:30:10 -04:00

README.txt

Title: Send Tracing Formatted Packet To The Host With Supported Backends

Description:

This application can be used to demonstrate the tracing feature. The tracing
formatted packet will be sent to the host with the currently supported tracing
backend under tracing generic infrastructure.

--------------------------------------------------------------------------------

Usage for UART Tracing Backend:

Build a UART-tracing image with:

    cmake -DBOARD=mps2_an521 -DCONF_FILE=prj_uart.conf ..

or:

    cmake -DBOARD=mps2_an521 -DCONF_FILE=prj_uart_ctf.conf ..

NOTE: You may need to set 'zephyr,tracing-uart' property under the chosen
node in your devicetree.  See boards/mps2_an521.overlay for an example.

After the application has run for a while, check the trace output file.

--------------------------------------------------------------------------------

Usage for USB Tracing Backend

Build a USB-tracing image with:

    cmake -DBOARD=sam_e70_xplained -DCONF_FILE=prj_usb.conf ..

or:

    cmake -DBOARD=sam_e70_xplained -DCONF_FILE=prj_usb_ctf.conf ..

After the serial console has stable output like this:

    threadA: Hello World!
    threadB: Hello World!
    threadA: Hello World!
    threadB: Hello World!

connect the board's USB port to the host device and
run the trace_capture_usb.py script on the host:

    sudo python3 trace_capture_usb.py -v 0x2FE9 -p 0x100 -o channel0_0

The VID and PID of USB device can be configured, just adjusting it accordingly.

--------------------------------------------------------------------------------

Usage for POSIX Tracing Backend

Build a POSIX-tracing image with:

    cmake -DBOARD=native_posix -DCONF_FILE=prj_native_posix.conf ..

or:

    cmake -DBOARD=native_posix -DCONF_FILE=prj_native_posix_ctf.conf ..

After the application has run for a while, check the trace output file.