Skip to content

Specify PICO_BOARD (and trailing whitespace). #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Specify PICO_BOARD (and trailing whitespace). #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 22 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ App|Description
[dump_console<sup>1</sup>](dump_console) | Read WLAN SoC's ARM core internal console and dump it to Pico's console.
[ioctl_test<sup>2</sup>](ioctl_test) | Write string via IOCTL to SoC's internal console, read back internal console, and dump it to Pico's console.

<sup>1</sup> Works with unmodified firmware provided by [cyw43-driver](https://github.com/georgerobotics/cyw43-driver).
<sup>1</sup> Works with unmodified firmware provided by [cyw43-driver](https://github.com/georgerobotics/cyw43-driver).
<sup>2</sup> Requires firmware that implements the `NEX_WRITE_TO_CONSOLE` IOCTL, uses [this patch](https://github.com/seemoo-lab/nexmon/tree/master/patches/bcm43439a0/7_95_49_2271bb6/nexmon) by default.

## Setup
Expand All @@ -25,55 +25,57 @@ There are various standard setups that allow working with a Raspberry Pi Pico W.
cd pico-nexmon
chmod u+x script/patch && script/patch
```
3. Setup [Raspberry Pi Pico SDK](https://github.com/raspberrypi/pico-sdk):
3. Setup [Raspberry Pi Pico SDK](https://github.com/raspberrypi/pico-sdk):
- This repository depends on the [pico-sdk](https://github.com/raspberrypi/pico-sdk). We recommend to head over to the [pico-sdk](https://github.com/raspberrypi/pico-sdk) repository, create a working setup by following its [README](https://github.com/raspberrypi/pico-sdk/blob/master/README.md), and build and try at least some of the [pico-examples](https://github.com/raspberrypi/pico-examples) for the Pico W before continuing here.
- **If you have a working Pico SDK and Pico W setup**, ensure that the environment variable `PICO_SDK_PATH` is set to the SDK's root before calling CMake, or directly pass the SDK location to CMake with `-DPICO_SDK_PATH=<path to pico-sdk>`.
4. Setup [Nexmon](https://github.com/seemoo-lab/nexmon.git):
4. Setup [Nexmon](https://github.com/seemoo-lab/nexmon.git):
- You might skip setting up Nexmon, if you are only interested in the `dump_rom` and/or `dump_console` applications. In this case, provide `-DNO_NEXMON=1` to CMake.
- **If you already have a working copy of the Nexmon framework**, ensure that the environment variable `NEXMON_ROOT` is set to the framework's root before calling CMake, or directly pass the framework location to CMake with `-DNEXMON_ROOT=<path to nexmon>`.
5. Build the applications:
1. Create and enter build directory.
5. Build the applications:
1. Create and enter build directory.
```
mkdir build && cd build
```
2. Use CMake to build the targets of your choice. Below are a couple examples:
- *Example A)* `PICO_SDK_PATH` and `NEXMON_ROOT` directly provided to CMake, build all applications:
2. Use CMake to build the targets of your choice. Below are a couple examples:
- *Example A)* `PICO_SDK_PATH`, `NEXMON_ROOT` and `PICO_BOARD` directly provided to CMake, build all applications:
```
cmake -DPICO_SDK_PATH=<path to pico-sdk> -DNEXMON_ROOT=<path to nexmon> ..
cmake -DPICO_SDK_PATH=<path to pico-sdk> -DPICO_BOARD=pico_w -DNEXMON_ROOT=<path to nexmon> ..
make
```
- *Example B)* `PICO_SDK_PATH` and `NEXMON_ROOT` set as environment variables, build all applications:
- *Example B)* `PICO_SDK_PATH`, `NEXMON_ROOT` and `PICO_BOARD` set as environment variables, build all applications:
```
export PICO_SDK_PATH=<path to pico-sdk>
export PICO_BOARD=pico_w
export NEXMON_ROOT=<path to nexmon>
cmake ..
make
```
- *Example C)* `PICO_SDK_PATH` set as environment variable, do not use nexmon, build all applications that do not depend on nexmon:
```
export PICO_SDK_PATH=<path to pico-sdk>
export PICO_BOARD=pico_w
cmake -DNO_NEXMON=1 ..
make
```
- *Example D)* `PICO_SDK_PATH` directly provided to CMake, do not use nexmon, build only `dump_rom` application:
- *Example D)* `PICO_SDK_PATH` directly provided to CMake, do not use nexmon, build only `dump_rom` application:
```
cmake -DPICO_SDK_PATH=<path to pico-sdk> -DNO_NEXMON=1 ..
cmake -DPICO_SDK_PATH=<path to pico-sdk> -DPICO_BOARD=pico_w -DNO_NEXMON=1 ..
make picow_dump_rom
```
6. Load and operate the application of your choice on your Raspberry Pi Pico W:
- **This step depends on your setup.** Please follow the official instructions from Raspberry Pi's documentation and getting started guides that match your setup.
- One example that works with our [setup](#setup) is to listen to the UART output using `minicom` and load the `dump_console` application with `openocd` as follows:
- **This step depends on your setup.** Please follow the official instructions from Raspberry Pi's documentation and getting started guides that match your setup.
- One example that works with our [setup](#setup) is to listen to the UART output using `minicom` and load the `dump_console` application with `openocd` as follows:
```
minicom -b 115200 -o -D /dev/ttyACM0
```
```
```
openocd -f interface/cmsis-dap.cfg -f target/rp2040.cfg -c "adapter speed 5000" -c "program dump_console/picow_dump_console.elf verify reset exit"
```
![](gfx/dump_console_example.gif)

## Quickstart
We provide scripts that automate the setup of `pico-sdk`, `openocd`, `minicom`, and `nexmon` on Ubuntu 22.04.3 LTS machines. Just copy and paste the following:
*We tested the scripts on a VM running [Ubuntu Server 22.04.3 LTS](https://releases.ubuntu.com/22.04.3/ubuntu-22.04.3-live-server-amd64.iso). They probably work on other versions and distributions too, but this is up to you to find out.*
We provide scripts that automate the setup of `pico-sdk`, `openocd`, `minicom`, and `nexmon` on Ubuntu 22.04.3 LTS machines. Just copy and paste the following:
*We tested the scripts on a VM running [Ubuntu Server 22.04.3 LTS](https://releases.ubuntu.com/22.04.3/ubuntu-22.04.3-live-server-amd64.iso). They probably work on other versions and distributions too, but this is up to you to find out.*
```
sudo apt update && \
sudo apt install -y git && \
Expand All @@ -97,11 +99,11 @@ For an example on how to use the applications check out step 6 of the [getting s
[Jakob Link](https://www.seemoo.tu-darmstadt.de/team/jlink/) <<[email protected]>>

## Reference the `pico-nexmon` project and the `nexmon` project:
Any use of this project which results in an academic publication or other publication which includes a bibliography should include a citation to the pico-nexmon project and the Nexmon project:
- J. Link and M. Hollick, ‘pico-nexmon: Raspberry Pi Pico W Nexmon Applications’, 2023. Available: https://github.com/seemoo-lab/pico-nexmon.
Any use of this project which results in an academic publication or other publication which includes a bibliography should include a citation to the pico-nexmon project and the Nexmon project:
- J. Link and M. Hollick, ‘pico-nexmon: Raspberry Pi Pico W Nexmon Applications’, 2023. Available: https://github.com/seemoo-lab/pico-nexmon.
[**CITATION.cff**](CITATION.cff)
- M. Schulz, D. Wegemer, and M. Hollick, ‘Nexmon: The C-based Firmware Patching Framework’, 2017. Available: https://nexmon.org.
[**CITATION.cff**](https://github.com/seemoo-lab/nexmon/blob/master/CITATION.cff)
- M. Schulz, D. Wegemer, and M. Hollick, ‘Nexmon: The C-based Firmware Patching Framework’, 2017. Available: https://nexmon.org.
[**CITATION.cff**](https://github.com/seemoo-lab/nexmon/blob/master/CITATION.cff)

# Powered By
## Secure Mobile Networking Lab (SEEMOO)
Expand Down