roll: host_tools

From: git_revision:1217abbb80bbe1f956cebe88ae5fcfe3db56a34b
To: git_revision:a9e249dad3cb9e29f7484d2a24a6def9337e0773

CQ-Do-Not-Cancel-Tryjobs: true
Roller-URL: https://ci.chromium.org/b/8862977295496621088
Cq-Cl-Tag: roller-builder:host-tools-roller
Cq-Cl-Tag: roller-bid:8862977295496621088
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I8a75671fdbc95509e098f6f36298036dee5b7484
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/25661
Reviewed-by: Pigweed Roller <pigweed-roller@pigweed.google.com.iam.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed.google.com.iam.gserviceaccount.com>
1 file changed
tree: e9370de7dbf9febcc61f22d3fce5331a1f56d0bd
  1. .bazelignore
  2. .clang-format
  3. .eslintrc.json
  4. .gitattributes
  5. .gitignore
  6. .gn
  7. .prettierrc.js
  8. .pylintrc
  9. AUTHORS
  10. BUILD
  11. BUILD.gn
  12. BUILDCONFIG.gn
  13. CMakeLists.txt
  14. CODE_OF_CONDUCT.md
  15. CONTRIBUTING.md
  16. LICENSE
  17. OWNERS
  18. PW_PLUGINS
  19. README.md
  20. WORKSPACE
  21. activate.bat
  22. bootstrap.bat
  23. bootstrap.sh
  24. build_overrides/
  25. docker/
  26. docs/
  27. modules.gni
  28. package.json
  29. pw_allocator/
  30. pw_arduino_build/
  31. pw_assert/
  32. pw_assert_basic/
  33. pw_assert_log/
  34. pw_base64/
  35. pw_bloat/
  36. pw_blob_store/
  37. pw_boot_armv7m/
  38. pw_build/
  39. pw_bytes/
  40. pw_checksum/
  41. pw_cli/
  42. pw_containers/
  43. pw_cpu_exception/
  44. pw_cpu_exception_armv7m/
  45. pw_docgen/
  46. pw_doctor/
  47. pw_env_setup/
  48. pw_fuzzer/
  49. pw_hdlc_lite/
  50. pw_hex_dump/
  51. pw_kvs/
  52. pw_log/
  53. pw_log_basic/
  54. pw_log_multisink/
  55. pw_log_null/
  56. pw_log_rpc/
  57. pw_log_tokenized/
  58. pw_malloc/
  59. pw_malloc_freelist/
  60. pw_metric/
  61. pw_minimal_cpp_stdlib/
  62. pw_module/
  63. pw_package/
  64. pw_polyfill/
  65. pw_preprocessor/
  66. pw_presubmit/
  67. pw_protobuf/
  68. pw_protobuf_compiler/
  69. pw_random/
  70. pw_result/
  71. pw_ring_buffer/
  72. pw_rpc/
  73. pw_span/
  74. pw_status/
  75. pw_stream/
  76. pw_string/
  77. pw_sys_io/
  78. pw_sys_io_arduino/
  79. pw_sys_io_baremetal_lm3s6965evb/
  80. pw_sys_io_baremetal_stm32f429/
  81. pw_sys_io_stdio/
  82. pw_target_runner/
  83. pw_tokenizer/
  84. pw_toolchain/
  85. pw_trace/
  86. pw_trace_tokenized/
  87. pw_unit_test/
  88. pw_varint/
  89. pw_watch/
  90. pw_web_ui/
  91. targets/
  92. third_party/
  93. tsconfig.json
  94. yarn.lock
README.md

Pigweed

Pigweed is an open source collection of embedded-targeted libraries--or as we like to call them, modules. These modules are building blocks and infrastructure that enable faster and more reliable development on small-footprint MMU-less 32-bit microcontrollers like the STMicroelectronics STM32L452 or the Nordic nRF52832.

Pigweed is in the early stages of development, and should be considered experimental. We’re continuing to evolve the platform and add new modules. We value developer feedback along the way.

Quick links

Get the code: git clone https://pigweed.googlesource.com/pigweed/pigweed

Getting Started

If you'd like to get set up with Pigweed, please visit the getting started guide.

What does Pigweed offer?

There are many modules in Pigweed, and this section only showcases a small selection that happen to produce visual output. For more information about the different Pigweed module offerings, refer to “Module Guides” section in the full documentation.

Note: For now the full documentation is not available online; you must build it. Building the docs is easy; see the getting started guide for how.

pw_watch - Build, flash, run, & test on save

In the web development space, file system watchers are prevalent. These watchers trigger a web server reload on source change, making development much faster. In the embedded space, file system watchers are less prevalent; however, they are no less useful! The Pigweed watcher module makes it easy to instantly compile, flash, and run tests upon save. Combined with the GN-based build which expresses the full dependency tree, only the exact tests affected by a file change are run on saves.

The demo below shows pw_watch building for a STMicroelectronics STM32F429I-DISC1 development board, flashing the board with the affected test, and verifying the test runs as expected. Once this is set up, you can attach multiple devices to run tests in a distributed manner to reduce the time it takes to run tests.

pw watch running on-device tests

pw_presubmit - Vacuum code lint on every commit

Presubmit checks are essential tools, but they take work to set up, and projects don’t always get around to it. The pw_presubmit module provides tools for setting up high quality presubmit checks for any project. We use this framework to run Pigweed’s presubmit on our workstations and in our automated building tools.

The pw_presubmit module includes pw format command, a tool that provides a unified interface for automatically formatting code in a variety of languages. With pw format, you can format C, C++, Python, GN, and Go code according to configurations defined by your project. pw format leverages existing tools like clang-format, and it’s simple to add support for new languages.

pw presubmit demo

pw_env_setup - Cross platform embedded compiler setup

A classic problem in the embedded space is reducing the time from git clone to having a binary executing on a device. The issue is that an entire suite of tools is needed for non-trivial production embedded projects. For example:

  • A C++ compiler for your target device, and also for your host
  • A build system or three; for example, GN, Ninja, CMake, Bazel
  • A code formatting program like clang-format
  • A debugger like OpenOCD to flash and debug your embedded device
  • A known Python version with known modules installed for scripting
  • A Go compiler for the Go-based command line tools
  • ... and so on

In the server space, container solutions like Docker or Podman solve this; however, in our experience container solutions are a mixed bag for embedded systems development where one frequently needs access to native system resources like USB devices, or must operate on Windows.

pw_env_setup is our compromise solution for this problem that works on Mac, Windows, and Linux. It leverages the Chrome packaging system CIPD to bootstrap a Python installation, which in turn inflates a virtual environment. The tooling is installed into your workspace, and makes no changes to your system. This tooling is designed to be reused by any project.