commit | 96c5702e347f992c09fb3536af6a08063c6b0e09 | [log] [tgz] |
---|---|---|
author | Kayce Basques <kayce@pigweed.infra.roller.google.com> | Thu Nov 21 19:52:16 2024 +0000 |
committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu Nov 21 19:52:16 2024 +0000 |
tree | ad38865755a693e33d9efa2b5dacf27055e3cf4c | |
parent | 7d0e894d48512ebd67ca5d1bd9e2355d7acccd08 [diff] |
roll: third_party/pigweed docs: Normalize SEED filenames Currently SEED filenames start with the SEED number but then include arbitrary text, e.g. 0002-template.rst. Automation of the SEED index will be easier if we normalize the filenames to only include the number, e.g. 0002.rst. SEED URLs will also be more predictable, e.g. pigweed.dev/seed/0002.html. This is prereq work for the migration of the docgen system to Bazel; it will be hard to migrate the SEED index auto-generation to Bazel if we don't make this change. Original-Bug: 318892911 Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248452 Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> Original-Revision: f4e18d1488c9d462a0d0da3342763a8864cb5200 Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 55f09ff7516de0..f4e18d1488c9d4 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8730631444067174705 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I723441be528ce89060c8fee8d857bd9f5366aad4 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/experimental/+/250472 Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
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!
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.
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:
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
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"
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"
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
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:
./out/rp2040/obj/applications/terminal_display/terminal_demo.uf2
to your Pi Pico.Using picotool
:
picotool
:picotool reboot -f -u
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.
Setup NXP SDK:
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.
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