roll: pigweed pw_bytes: Add PackedPtr

Every object types has an alignment requirement, and for most types this
is greater than one. As a result, pointers to these types have one or
more least significant bits that are always zero. For certain types,
such as intrusive container types, it is desirable to reuse these bits
and avoid creating additional fields.

This class facilitates those use cases by providing a wrapper type that
can be treated like a pointer in many cases, but that can also be used
to set and get a value from the unused bits.

This storage is not free: this class must perform bit operations on
every dereference, adding to its performance cost and code size. This
class should only be used when the benefits of saving memory overhead
outweigh these costs.

Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/235104
Original-Revision: cda5ba673366d189e0ea326a0fa808df181730a7

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: faac61757b5428..cda5ba673366d1
Roller-URL: https://ci.chromium.org/b/8736437843974743713
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ib8de5dd948a3cb3a6eb0f46a56796729fe2a49b9
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/236774
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: 8e3431cf46270221da4355427342b56225775ba3
  1. .github/
  2. .vscode/
  3. apps/
  4. modules/
  5. system/
  6. targets/
  7. tools/
  8. .bazelignore
  9. .bazelrc
  10. .bazelversion
  11. .buildifier.json
  12. .clang-format
  13. .clangd.shared
  14. .gitignore
  15. .pw_console.yaml
  16. AUTHORS
  17. BUILD.bazel
  18. CONTRIBUTING.md
  19. LICENSE
  20. MODULE.bazel
  21. OWNERS
  22. pigweed.json
  23. README.md
README.md

Pigweed: minimal Bazel example

This repository contains a minimal example of a Bazel-based Pigweed project. It is a LED-blinking service (featuring RPC control!) for the Raspberry Pi Pico. It can also be run on any computer using the included simulator.

Getting the code

git clone https://pigweed.googlesource.com/pigweed/quickstart/bazel pw_bazel_quickstart
cd pw_bazel_quickstart

Dependencies

The only dependency that must be installed is Bazelisk.

Bazelisk is a launcher for the Bazel build system that allows for easy management of multiple Bazel versions.

Instructions for installing Bazelisk can be found here.

Running on the simulator

To run the simulator, type: bazelisk run //apps/blinky:simulator_blinky Then, in a new console, connect to the simulator using: bazelisk run //apps/blinky:simulator_console

Running on hardware

To start, connect a Raspberry Pi Pico, Pico 2, or debug probe via USB.

To run on the Raspberry Pi Pico, type: bazelisk run //apps/blinky:flash_rp2040 Then, in a new console, connect to the device using: bazelisk run //apps/blinky:rp2040_console

Controlling the LED

Once connected with a console, RPCs can be sent to control the LED. Try running:

device.set_led(True)
device.set_led(False)
device.toggle_led()
device.blink(blink_count=3)

Running unit tests on the host device

bazelisk test //... will run the unit tests defined in this project, such as the ones in modules/blinky/blinky_test.cc.

Running unit tests on hardware

bazelisk run @pigweed//targets/rp2040/py:unit_test_server in one console followed by bazelisk test //... --config=rp2040 will also allow running the unit tests on-device.

Next steps

Try poking around the codebase for inspiration about how Pigweed projects can be organized. Most of the relevant code in this quickstart (including RPC definitions) is inside modules/blinky, with some client-side Python code in tools/console.py.