[roll third_party/pigweed] pw_trace: log extra event data as hex bytes

Testing done:
- tested with my target

Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/20282

Rolled-Commits: c9759dc415e0771..918276537a01f4f
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: If6158628e2b25a1d01d81f2d0c808f5206da49da
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/sample_project/+/21720
Reviewed-by: Pigweed Integration Roller <pigweed-integration-roller@pigweed.google.com.iam.gserviceaccount.com>
Commit-Queue: Pigweed Integration Roller <pigweed-integration-roller@pigweed.google.com.iam.gserviceaccount.com>
1 file changed
tree: 6cbddbb2bbe6336e8e254875747e57ed74eb18f4
  1. .gitignore
  2. .gitmodules
  3. .gn
  4. BUILD.gn
  5. BUILDCONFIG.gn
  6. README.md
  7. activate.bat
  8. banner.txt
  9. bootstrap.bat
  10. bootstrap.sh
  11. build_overrides/
  12. source/
  13. targets/
  14. third_party/
  15. tools/
README.md

Pigweed Sample Project

This repository outlines the recommended way of using Pigweed in a new or existing project. Feel free to fork this repository, or read it as a reference.

For more information see the Pigweed Getting started guide

Check back for more complex examples and features coming soon!

Repository setup

The preferred method to add the Pigweed source is to use git submodules and place the Pigweed source repository in third_party/pigweed. If you forked this repository, don't forget to run git submodule init and git submodule update.

Environment Setup

The scripts bootstrap.bat for Windows, and bootstrap.sh for Unix systems call the respective Pigweed bootstrap scripts. Feel free to modify them to set up your development environment for the first time.

After the initial setup, use the activate.bat in Windows or activate.sh in Unix to enter the environment in a shell.

Banner

Make the project yours with your own banner. Create your own banner and place it in banner.txt.

Building

Generate the build files with gn gen out once, unless the build configuration has changed. Then, use ninja to build everything with ninja -C out.

The sample project examples have dependencies, each with some required build arguments. See the Arduino, and RPC sections for more setup information. The build arguments can be set with gn args out.

Pigweed's File System Watcher

Speed up iteration running pw watch on a new terminal window. This utility builds targets and runs tests when their files are modified. See the pw_watch documentation for more information.

Presubmits

Sample presubmit checks are included in tools/presubmit_checks.py. To install them run python tools/presubmit_checks.py --install. See the pw_presubmit module documentation for more information.

Sample Application

The sample application in source/main.cc uses the sample module simple_counter. Look at source/BUILD.gn and source/simple_counter/BUILD.gn to see how these are built respectively. The key part is in the root BUILD.gn, which creates the host target using the host toolchain. A toolchain is required for each target.

Build the project and run the application.

./out/host_clang_debug/obj/source/bin/hello_world

Sample Test

The simple_counter module has tests defined in source/simple_counter_tests.cc. Look at source/simple_counter/BUILD.gn for an example of how a test is defined. The root BUILD.gn groups all the host tests together.

Build the project and run the tests.

./out/host_clang_debug_tests/obj/source/simple_counter/test/simple_counter_test

Tokenized Logging

Log entries in the sample app are tokenized to save binary space. The included tokens database, source/tokenizer_database.csv, is updated on each build. See the Pigweed pw_tokenizer for more information.

Optionally, the database can be created manually using the binary or the .elf file.

python -m pw_tokenizer.database create \
    --database source/tokenizer_database.csv \
    out/host_clang_debug/obj/source/bin/hello_world

Running the app shows log entries similiar to $kgjLdg==. These can be saved to a file and then detokenized.

./out/host_clang_debug/obj/source/bin/hello_world > log.txt
python -m pw_tokenizer.detokenize base64 source/tokenizer_database.csv -i log.txt

Or can be detokenized in realtime.

./out/host_clang_debug/obj/source/bin/hello_world | python \
    -m pw_tokenizer.detokenize base64 source/tokenizer_database.csv

Arduino Example

Prerequisites

To build for Arduino boards you must install a core. At this time only the Teensyduino core is supported.

Check the Pigweed pw_arduino_build module documentation for detailed installation instructions. Cores should be installed into third_party/piwgweed/third_party/arduino.

Run this to install the Teensy core:

arduino_builder install-core \
  --prefix ./third_party/pigweed/third_party/arduino/cores/ \
  --core-name teensy

NOTE: At this time the Teensyduino core does not build with the c++17 standard which is required for Pigweed. There is an open pull request to fix this but in the meantime you will need to patch the core files. This will download a diff and patch the relevant files:

pushd ./third_party/pigweed/third_party/arduino/cores/teensy/hardware/teensy/avr/cores/
curl -O https://gist.githubusercontent.com/AnthonyDiGirolamo/9368d2879d9aec6be4118e72c2b0cf46/raw/0afc6c182dcb3aac5af3f05d54c4d2c7d941b52d/teensy34_cpp17_patch.diff
patch -p1 < teensy34_cpp17_patch.diff
popd

Arduino Files in the sample_project

  • source/arduino_example
    • An example application that uses the Arduino API included in Arduino.h.
  • source/arduino_example/BUILD.gn
    • Demonstrates how to include the Arduino core dependencies.
  • source/main.cc
    • A sample application that can be compiled for a supported Arduino board.
  • BUILD.gn
    • Shows how to create a target using the Arduino toolchain.
  • source/target/arduino
    • Contains a sample toolchain that inherits from the an Arduino toolchain in upstream pigweed. It can override backends as needed.

Building

To build for a Teensy 3.1 board run the following.

gn gen out --args='
  dir_pw_third_party_arduino="//third_party/pigweed/third_party/arduino"
  arduino_board="teensy31"'
ninja -C out

Where arduino_board= is one of:

  • "teensy41" - Teensy 4.1
  • "teensy40" - Teensy 4.0
  • "teensy36" - Teensy 3.6
  • "teensy35" - Teensy 3.5
  • "teensy31" - Teensy 3.2 / 3.1

Running Tests

Tests can be manually flashed an run with the arduino_unit_test_runner and the .elf file.

arduino_unit_test_runner --verbose \
    --config-file ./out/arduino_debug/gen/arduino_builder_config.json \
    --upload-tool teensyloader \
    out/arduino_debug_tests/obj/source/simple_counter/test/simple_counter_test.elf

If you would like to use the unit test server to automatically run your tests you must set the pw_arduino_use_test_server=true build arg and startup the test server. Then in a second window start the pw watch command.

  1. Start the test server in it's own terminal window.

    gn gen out --args='
      dir_pw_third_party_arduino="//third_party/pigweed/third_party/arduino"
      arduino_core_name="teensy"
      arduino_board="teensy40"
      pw_arduino_use_test_server=true'
    arduino_test_server --verbose \
      --config-file ./out/arduino_debug/gen/arduino_builder_config.json
    
  2. Start pw watch with the arduino target in a separate terminal.

    pw watch out arduino
    

For additional details check the Pigweed arduino_builder documentation in:

RPC Example

The sample project uses nanopb for its pw_rpc dependency. The nanopb repo is conveniently included as a git submodule. This installation can be overridden following the instructions in third_party/pigweed/third_party/nanopb/BUILD.gn. Then set dir_pw_third_party_nanopb to the new installation location when building. For example:

gn gen out --args='dir_pw_third_party_nanopb="third_party/nanopb"'

The sample application registers the EchoService, which echoes any RPC message data sent to it. To test it out build for and flash the desired board, then run:

python third_party/pigweed/pw_hdlc_lite/rpc_example/example_script.py \
    --device /dev/ttyACM0 --baud 115200

At the time of writing, the example_script.py does not parse log statements if they are not framed in the HDLC protocol used by RPC. There is ongoing work on an RPC log service that will handle sending logs in HDLC frames to an RPC channel. In addition, the sample application uses tokenized logging, which means that logs need to be detokenized after the RPC HDLC frames are decoded on the host side. To do that flash the hello_word application and use two terminals to parse RPCs and detokenize logs respectively.

Terminal 1: receive RPCs.

source activate.sh
python -m pw_hdlc_lite.rpc_console \
       -o logfile.txt \
       -d /dev/ttyACM0 \
       ./third_party/pigweed/pw_rpc/pw_rpc_protos/echo.proto

Test Echo RPC:

rpcs.pw.rpc.EchoService.Echo(msg="hola")

Terminal 2: decode the logfile.

source activate.sh
tail -f logfile.txt | python -m pw_tokenizer.detokenize \
    base64 source/tokenizer_database.csv