Skip to content

Commit

Permalink
Include documentation for building BP6 binaries also.
Browse files Browse the repository at this point in the history
  • Loading branch information
henrygab committed Nov 9, 2024
1 parent a593770 commit ed89fc5
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
build/**
build6/**
.vscode/**
.env

1 change: 0 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ set(PICO_BOARD_HEADER_DIRS ${CMAKE_CURRENT_LIST_DIR}/src/boards )
set(PICO_BOARD_CMAKE_DIRS ${CMAKE_CURRENT_LIST_DIR}/src/boards )
# Add my_pico_w
#
#set(BP_PICO_PLATFORM "rp2350")

if(DEFINED GIT_COMMIT_HASH)
set(BP_FIRMWARE_HASH ${GIT_COMMIT_HASH})
Expand Down
12 changes: 10 additions & 2 deletions hacks/build_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,18 @@ source /etc/profile.d/pico-sdk.sh
```
sudo git clone https://github.com/DangerousPrototypes/BusPirate5-firmware.git bp5-main
cd bp5-main
md build
cd build
mkdir build
mkdir build6
pushd build
cmake ..
make
popd
pushd build6
cmake .. -DPICO_SDK_FETCH_FROM_GIT=TRUE -DBP_PICO_PLATFORM=rp2350
make
popd
```

# Install build script and webhook
Expand Down
17 changes: 14 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ Bus Pirate 5 is the universal serial interface tool designed by hackers, for hac

This project uses `cmake` as the build system, so building the project only takes 2 steps:
1. project configuration (needs to be ran once, or when you want to change configuration).
`cmake -S . -B build -DPICO_SDK_FETCH_FROM_GIT=TRUE`
`cmake -S . -B build -DPICO_SDK_FETCH_FROM_GIT=TRUE`
`cmake -S . -B build6 -DPICO_SDK_FETCH_FROM_GIT=TRUE -DBP_PICO_PLATFORM=rp2350`
you may want to add the flags `-DPICO_SDK_PATH=/path/to/pico-sdk -DPICO_SDK_FETCH_FROM_GIT=FALSE` if you want to use pico-sdk that is in your local path.
> NOTE: WINDOWS users: for some reason the automatic fetch fails because of git submodule, so you will need to clone pico-sdk your self, and then
> apply the following commands inside the pico-sdk repo:
Expand All @@ -48,8 +49,18 @@ This project uses `cmake` as the build system, so building the project only take
> ```
2. project build
`cmake --build ./build --target bus_pirate5_rev10`
you may set `bus_pirate5_rev10` to `bus_pirate5_rev8` if the have the development version.
`cmake --build ./build`
`cmake --build ./build6`
you may add a specific target, such as:
`cmake --build ./build --target bus_pirate5_rev8`
`cmake --build ./build --target bus_pirate5_rev10`
`cmake --build ./build6 --target bus_pirate5_xl`
`cmake --build ./build6 --target bus_pirate6`
you can manually clean via:
`cmake --build ./build --target clean`
`cmake --build ./build6 --target clean`
Finally, you can force a clean prior to building by adding `--clean-first`.
### build using docker
Instructions on the forum provide additional details; however, this repo provides a docker compose image for you to just get running quickly in the event you want to try patching/hacking.
Expand Down

0 comments on commit ed89fc5

Please sign in to comment.