Google Git
Sign in
pigweed / pigweed / experimental / 0e6d3f5823297e4f11d2dce9ec7c32caa89ff7b7
commit0e6d3f5823297e4f11d2dce9ec7c32caa89ff7b7[log] [tgz]
authorKayce Basques <kayce@pigweed.infra.roller.google.com>Fri Jun 20 10:40:05 2025 -0700
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Fri Jun 20 10:40:05 2025 -0700
tree80cb47267a64a157f07835f8fa81f72369cf8f0e
parentc5699bc9c8cb5fd95cfe559513bc1e87424ea39f [diff]
roll: third_party/pigweed docs: Re-introduce Doxyfile

* Use a Doxyfile instead of configuring Doxygen from our Bazel
  rule to reduce log spew and make our Doxygen system more portable.
* Sort the Doxyfile alphabetically.
* Replace the auto-generated basic usage comments with links to
  Doxygen's docs. This makes it easier to focus on Pigweed-specific
  comments and customizations.
* When the default value for an option is used, remove that option
  from the Doxyfile entirely so that we can focus on the options that
  we have overridden.
* Enable a few flags that seem sensible to turn on.

None of these changes should affect the Breathe/Sphinx integration.
The Doxygen site might be affected by the changes but we will be
revisiting everything over the next quarter anyways as we majorly
customize the Doxygen site for our needs.

Original-Bug: 426012010
Original-Fixes: 384047922
Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/299332
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Original-Revision: b42e92f7df3c2feb8ce439d474065f59345a7c13

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 0d9eeccd9430ed..b42e92f7df3c2f
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8711523713824109569
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I25df4a69804d402f0bbc0342000199b945d90734
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/experimental/+/299461
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
1 file changed
tree: 80cb47267a64a157f07835f8fa81f72369cf8f0e
  1. applications/
  2. build_overrides/
  3. infra/
  4. pw_async_bench/
  5. pw_board_led/
  6. pw_board_led_arduino/
  7. pw_board_led_host/
  8. pw_board_led_mimxrt595_evk/
  9. pw_board_led_pico/
  10. pw_board_led_stm32cube/
  11. pw_board_led_stm32f429i_disc1/
  12. pw_board_led_stm32f769i_disc0/
  13. pw_digital_io_arduino/
  14. pw_digital_io_null/
  15. pw_digital_io_stm32cube/
  16. pw_display_driver/
  17. pw_display_driver_ili9341/
  18. pw_display_driver_imgui/
  19. pw_display_driver_mipi/
  20. pw_display_driver_null/
  21. pw_display_driver_st7735/
  22. pw_display_driver_st7789/
  23. pw_graphics/
  24. pw_mipi_dsi/
  25. pw_mipi_dsi_mcuxpresso/
  26. pw_pixel_pusher/
  27. pw_pixel_pusher_rp2040_pio/
  28. pw_spi_arduino/
  29. pw_spi_stm32cube/
  30. pw_spin_delay/
  31. pw_spin_delay_arduino/
  32. pw_spin_delay_host/
  33. pw_spin_delay_mcuxpresso/
  34. pw_spin_delay_rp2040/
  35. pw_spin_delay_stm32cube/
  36. pw_spin_delay_stm32f429i_disc1/
  37. pw_spin_delay_stm32f769i_disc0/
  38. pw_sys_io_baremetal_stm32f769/
  39. pw_toolchain_extra/
  40. targets/
  41. third_party/
  42. tools/
  43. .clang-format ⇨ third_party/pigweed/.clang-format
  44. activate.sh ⇨ bootstrap.sh
  45. .bazelignore
  46. .bazelrc
  47. .bazelversion
  48. .clang-tidy
  49. .gitattributes
  50. .gitignore
  51. .gitmodules
  52. .gn
  53. activate.bat
  54. banner.txt
  55. bootstrap.bat
  56. bootstrap.sh
  57. BUILD.bazel
  58. BUILD.gn
  59. BUILDCONFIG.gn
  60. MODULE.bazel
  61. modules.gni
  62. navbar.md
  63. OWNERS
  64. pigweed.json
  65. README.md
  66. ROLLER_OWNERS
README.md

Pigweed Experimental

This repository contains a variety experiments to help inform various Pigweed policies, designs, and implementation behaviors.

Code in this repository is not reviewed to the standard of the main Pigweed repository, and generally speaking is untested and maintained on a best-effort basis. This is not a repository of “early access” Pigweed modules, but more so a sandbox for Pigweed contributors to collaborate on investigations. For more information, see the contribution guidelines for the experimental repository and where to land code.

DO NOT DEPEND ON THIS REPOSITORY IN ANY PRODUCTION PROJECT!

Repository setup

Clone this repo with --recursive to get all required submodules.

git clone --recursive https://pigweed.googlesource.com/pigweed/experimental

This will pull the Pigweed source repository into third_party/pigweed. If you already cloned but forgot to --recursive run git submodule update --init to pull all submodules.

pw_graphics

The //pw_graphics folder contains some libraries for drawing to an RGB565 framebuffer and displaying it on various platforms.

The demo applications that make use of these libraries are:

Build instructions

First time setup:

git clone --recursive https://pigweed.googlesource.com/pigweed/experimental
cd experimental
. ./bootstrap.sh
pw package install imgui
pw package install glfw
pw package install stm32cube_f4
pw package install pico_sdk

STM32F429-DISC1

Compile:

gn gen out --export-compile-commands --args="
  dir_pw_third_party_stm32cube_f4=\"$PW_PROJECT_ROOT/environment/packages/stm32cube_f4\"
"
ninja -C out

Flash:

openocd -f third_party/pigweed/targets/stm32f429i_disc1/py/stm32f429i_disc1_utils/openocd_stm32f4xx.cfg -c "program out/stm32f429i_disc1_stm32cube_debug/obj/applications/terminal_display/bin/terminal_demo.elf verify reset exit"

STM32F769-DISC0

First time setup:

pw package install stm32cube_f7

Compile:

gn gen out --export-compile-commands --args="
  dir_pw_third_party_stm32cube_f7=\"//environment/packages/stm32cube_f7\"
"
ninja -C out

Flash:

openocd -f targets/stm32f769i_disc0/py/stm32f769i_disc0_utils/openocd_stm32f7xx.cfg \
  -c "program out/stm32f769i_disc0_debug/obj/applications/blinky/bin/blinky.elf verify reset exit"

Linux, Windows or Mac

Compile:

gn gen out --export-compile-commands --args="
  dir_pw_third_party_imgui=\"$PW_PROJECT_ROOT/environment/packages/imgui\"
  dir_pw_third_party_glfw=\"$PW_PROJECT_ROOT/environment/packages/glfw\"
"
ninja -C out

Run:

out/host_debug/obj/applications/terminal_display/bin/terminal_demo

CURRENTLY NOT WORKING (https://pwbug.dev/325649415) - Raspberry Pi Pico Connected to an external SPI display

Working displays:

First time setup:

pw package install pico_sdk

Compile:

gn gen out --export-compile-commands --args='
  PICO_SRC_DIR="//environment/packages/pico_sdk"
'
ninja -C out

Flash:

  • Using a uf2 file:

    1. Reboot pico into BOOTSEL mode by holding the bootsel button on startup.
    2. Copy ./out/rp2040/obj/applications/terminal_display/terminal_demo.uf2 to your Pi Pico.

  • Using picotool:

    1. Reboot pico into BOOTSEL mode by holding the bootsel button on startup. Or try forcing a reboot with picotool:
    picotool reboot -f -u
    1. Flash the elf or uf2 file and reboot.
    picotool load ./out/rp2040/obj/applications/terminal_display/bin/terminal_demo.elf
picotool reboot

  • Using a Pico Probe and openocd:

    This requires installing the Raspberry Pi foundation's OpenOCD fork for the Pico probe. More details including how to connect the two Pico boards is available at Raspberry Pi Pico and RP2040 - C/C++ Part 2: Debugging with VS Code

    Install RaspberryPi's OpenOCD Fork:

    git clone https://github.com/raspberrypi/openocd.git \
  --branch picoprobe \
  --depth=1 \
  --no-single-branch \
  openocd-picoprobe

cd openocd-picoprobe

./bootstrap
./configure --enable-picoprobe --prefix=$HOME/apps/openocd --disable-werror
make -j2
make install

    Setup udev rules (Linux only):

    cat <<EOF > 49-picoprobe.rules
SUBSYSTEMS=="usb", ATTRS{idVendor}=="2e8a", ATTRS{idProduct}=="0004", MODE:="0666"
KERNEL=="ttyACM*", ATTRS{idVendor}=="2e8a", ATTRS{idProduct}=="0004", MODE:="0666"
EOF
sudo cp 49-picoprobe.rules /usr/lib/udev/rules.d/49-picoprobe.rules
sudo udevadm control --reload-rules

    Flash the Pico:

    ~/apps/openocd/bin/openocd -f ~/apps/openocd/share/openocd/scripts/interface/picoprobe.cfg -f ~/apps/openocd/share/openocd/scripts/target/rp2040.cfg -c 'program out/rp2040/obj/applications/terminal_display/bin/terminal_demo.elf verify reset exit'

    Launching gdb*

    ~/apps/openocd/bin/openocd -f ~/apps/openocd/share/openocd/scripts/interface/picoprobe.cfg -f ~/apps/openocd/share/openocd/scripts/target/rp2040.cfg

    gdb-multiarch -ex "target remote :3333" -ex "set print pretty on" out/rp2040/obj/applications/terminal_display/bin/terminal_demo.elf

    arm-none-eabi-gdb can be used in place of gdb-multiarch above.

MIMXRT595-EVK Connected to an external MIPI display

Setup NXP SDK:

  1. Build a NXP SDK
  2. Download SDK
  3. Extract SDK's zip file to //environment/SDK_2_12_1_EVK-MIMXRT595

Compile:

gn gen out --export-compile-commands --args="
  pw_MIMXRT595_EVK_SDK=\"//environment/SDK_2_12_1_EVK-MIMXRT595\"
  pw_target_mimxrt595_evk_MANIFEST=\"//environment/SDK_2_12_1_EVK-MIMXRT595/EVK-MIMXRT595_manifest_v3_10.xml\"
  pw_third_party_mcuxpresso_SDK=\"//targets/mimxrt595_evk:mimxrt595_sdk\"
"

ninja -C out

Flash the MIMXRT595-EVK:

Follow the instructions to flash the MIMXRT595-EVK with the SEGGER J-Link firmware and using arm-none-eabi-gdb at https://pigweed.dev/targets/mimxrt595_evk/target_docs.html#running-and-debugging.

Teensy 4.1

https://www.pjrc.com/teensy/loader_cli.html

brew install teensy_loader_cli

OBJCOPY=/Applications/Arduino.app/Contents/Java/hardware/tools/avr/bin/avr-objcopy
INFILE=out/arduino_debug/obj/applications/terminal_display/bin/terminal_demo.elf
OUTFILE=foo.hex
$OBJCOPY -O ihex -R .eeprom -R .fuse -R .lock -R .signature $INFILE $OUTFILE
teensy_loader_cli --mcu=TEENSY41 -w -v $OUTFILE