TECHNICAL AND RELIABILITY DATA FOR RASPBERRY PI PRODUCTS (INCLUDING DATASHEETS) AS MODIFIED FROM
TIME TO TIME (“RESOURCES”) ARE PROVIDED BY RASPBERRY PI LTD (“RPL”) "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN NO
EVENT SHALL RPL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THE RESOURCES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
RPL reserves the right to make any enhancements, improvements, corrections or any other modifications to the
RESOURCES or any products described in them at any time and without further notice.
The RESOURCES are intended for skilled users with suitable levels of design knowledge. Users are solely responsible for
their selection and use of the RESOURCES and any application of the products described in them. User agrees to
indemnify and hold RPL harmless against all liabilities, costs, damages or other losses arising out of their use of the
RESOURCES.
RPL grants users permission to use the RESOURCES solely in conjunction with the Raspberry Pi products. All other use
of the RESOURCES is prohibited. No licence is granted to any other RPL or other third party intellectual property right.
HIGH RISK ACTIVITIES. Raspberry Pi products are not designed, manufactured or intended for use in hazardous
environments requiring fail safe performance, such as in the operation of nuclear facilities, aircraft navigation or
communication systems, air traffic control, weapons systems or safety-critical applications (including life support
systems and other medical devices), in which the failure of the products could lead directly to death, personal injury or
severe physical or environmental damage (“High Risk Activities”). RPL specifically disclaims any express or implied
warranty of fitness for High Risk Activities and accepts no liability for use or inclusions of Raspberry Pi products in High
Risk Activities.
Raspberry Pi products are provided subject to RPL’s Standard Terms. RPL’s provision of the RESOURCES does not
expand or otherwise modify RPL’s Standard Terms including but not limited to the disclaimers and warranties
expressed in them.
If you are developing for Raspberry Pi Pico on the Raspberry Pi 4B, or the Raspberry Pi 400, most of the installation
steps in this Getting Started guide can be skipped by running the setup script.
NOTE
This setup script requires approximately 2.5GB of disk space on your SD card, so make sure you have enough free
space before running it. You can check how much free disk space you have with the df -h command.
You can get this script by running the following command in a terminal:
$ wget https://raw.githubusercontent.com/raspberrypi/pico-setup/master/pico_setup.sh ①
1.
You should first sudo apt install wget if you don’t have wget already installed.
Then make the script executable with,
$ chmod +x pico_setup.sh
and run it with,
$ ./pico_setup.sh
The script will:
Create a directory called pico
•
Install required dependencies
•
Download the pico-sdk, pico-examples, pico-extras, and pico-playground repositories
•
Define PICO_SDK_PATH, PICO_EXAMPLES_PATH, PICO_EXTRAS_PATH, and PICO_PLAYGROUND_PATH in your ~/.bashrc
•
Build the blink and hello_world examples in pico-examples/build/blink and pico-examples/build/hello_world
•
Download and build picotool (see Appendix B), and copy it to /usr/local/bin.
•
Download and build picoprobe (see Appendix A).
•
Download and compile OpenOCD (for debug support)
•
Download and install Visual Studio Code
•
Install the required Visual Studio Code extensions (see Chapter 7 for more details)
•
Configure the Raspberry Pi UART for use with Raspberry Pi Pico
•
Chapter 1. Quick Pico Setup4
Page 6
Getting started with Raspberry Pi Pico
NOTE
The pico directory will be created in the folder where you run the pico_setup.sh script.
Once it has run, you will need to reboot your Raspberry Pi,
$ sudo reboot
for the UART reconfiguration to take effect. Once your Raspberry Pi has rebooted you can open Visual Studio Code in
the "Programming" menu and follow the instructions from Section 7.2.
Chapter 1. Quick Pico Setup5
Page 7
Getting started with Raspberry Pi Pico
Chapter 2. The SDK
IMPORTANT
The following instructions assume that you are using a Raspberry Pi Pico and some details may differ if you are
using a different RP2040-based board. They also assume you are using Raspberry Pi OS running on a Raspberry Pi 4,
or an equivalent Debian-based Linux distribution running on another platform. Alternative instructions for those
using Microsoft Windows (see Section 9.2) or Apple macOS (see Section 9.1) are also provided.
The Raspberry Pi Pico is built around the RP2040 microcontroller designed by Raspberry Pi. Development on the board
is fully supported with both a C/C++ SDK, and an official MicroPython port. This book talks about how to get started
with the SDK, and walks you through how to build, install, and work with the SDK toolchain.
TIP
For more information on the official MicroPython port see the Raspberry Pi Pico Python SDK book which documents
the port, and Get started with MicroPython on Raspberry Pi Pico by Gareth Halfacree and Ben Everard, published by
Raspberry Pi Press.
TIP
For more information on the C/C++ SDK, along with API-level documentation, see the Raspberry Pi Pico C/C++ SDK
book.
2.1. Get the SDK and examples
The pico-examples repository (https://github.com/raspberrypi/pico-examples) provides a set of example applications
that are written using the pico-sdk (https://github.com/raspberrypi/pico-sdk). To clone these repositories start by
creating a pico directory to keep all pico related checkouts in. These instructions create a pico directory at /home/pi/pico.
$ cd ~/
$ mkdir pico
$ cd pico
Then clone the pico-sdk and pico-examples git repositories.
Failure to run the git submodule update --init command above will mean that the tinyusb module will not be included,
and as a result USB functionality will not be compiled into the SDK. This means that USB serial, other USB functions,
and example code will not work.
NOTE
There are additional repositories: pico-extras, and pico-playground that you may also be interested in.
2.2. Install the Toolchain
To build the applications in pico-examples, you’ll need to install some extra tools. To build projects you’ll need CMake, a
cross-platform tool used to build the software, and the GNU Embedded Toolchain for Arm. You can install both these via
apt from the command line. Anything you already have installed will be ignored by apt.
Native gcc and g++ are needed to compile pioasm and elf2uf2.
NOTE
Ubuntu and Debian users might additionally need to also install libstdc++-arm-none-eabi-newlib.
2.3. Updating the SDK
When a new version of the SDK is released you will need to update your copy of the SDK. To do this go into the pico-sdk
directory which contains your copy of the SDK, and do the following;
$ cd pico-sdk
$ git pull
$ git submodule update
NOTE
If you wish to be informed of new releases you can get notified by setting up a custom watch on the pico-sdk
repository. Navigate to https://github.com/raspberrypi/pico-sdk and then select Watch → Custom → Releases. You
will receive an email notification every time there is a new SDK release.
2.2. Install the Toolchain7
Page 9
Getting started with Raspberry Pi Pico
Chapter 3. Blinking an LED in C
When you’re writing software for hardware, turning an LED on, off, and then on again, is typically the first program that
gets run in a new programming environment. Learning how to blink an LED gets you half way to anywhere. We’re going
to go ahead and blink the on-board LED on the Raspberry Pi Pico which is connected to pin 25 of the RP2040.
Ê9 int main() {
10 #ifndef PICO_DEFAULT_LED_PIN
11 #warning blink example requires a board with a regular LED
12 #else
13 const uint LED_PIN = PICO_DEFAULT_LED_PIN;
14 gpio_init(LED_PIN);
15 gpio_set_dir(LED_PIN, GPIO_OUT);
16 while (true) {
17 gpio_put(LED_PIN, 1);
18 sleep_ms(250);
19 gpio_put(LED_PIN, 0);
20 sleep_ms(250);
21 }
22 #endif
23 }
3.1. Building "Blink"
From the pico directory we created earlier, cd into pico-examples and create a build directory.
$ cd pico-examples
$ mkdir build
$ cd build
Then, assuming you cloned the pico-sdk and pico-examples repositories into the same directory side-by-side, set the
PICO_SDK_PATH:
$ export PICO_SDK_PATH=../../pico-sdk
TIP
Throughout this book we use the relative path ../../pico-sdk to the checkout of the SDK for the PICO_SDK_PATH.
However depending on the location of your checkout it might make sense to replace this with the absolute path, e.g.
/home/pi/pico/pico-sdk.
Prepare your cmake build directory by running cmake ..
$ cmake ..
Using PICO_SDK_PATH from environment ('../../pico-sdk')
PICO_SDK_PATH is /home/pi/pico/pico-sdk
Ê .
3.1. Building "Blink"8
Page 10
Getting started with Raspberry Pi Pico
Ê .
Ê .
-- Build files have been written to: /home/pi/pico/pico-examples/build
NOTE
cmake will default to a Release build with compiler optimisations enabled and debugging information removed. To
build a debug version, run cmake -DCMAKE_BUILD_TYPE=Debug ... We will explore this later in Section 6.1.
CMake has now prepared a build area for the pico-examples tree. From here, it is possible to type make to build all example
applications. However, as we are building blink we will only build that application for now by changing directory into the
blink directory before typing make.
TIP
Invoking make with -j4 will run four make jobs in parallel to speed it up. A Raspberry Pi 4 has 4 cores so -j4 is a
reasonable number.
$ cd blink
$ make -j4
Scanning dependencies of target ELF2UF2Build
Scanning dependencies of target boot_stage2_original
[ 0%] Creating directories for 'ELF2UF2Build'
Ê .
Ê .
Ê .
[100%] Linking CXX executable blink.elf
[100%] Built target blink
Amongst other targets, we have now built:
blink.elf, which is used by the debugger
•
blink.uf2, which can be dragged onto the RP2040 USB Mass Storage Device
•
This binary will blink the on-board LED of the Raspberry Pi Pico which is connected to GPIO25 of RP2040.
More detail on the example code?
This document shows how to build software and load it onto your Raspberry Pi Pico. A lot goes on
behind the scenes to turn our blink application into a binary program, and the Raspberry Pi Pico C/C++
SDK book pulls back the curtain and shows some of the machinery involved. If you aren’t worried about
this kind of thing yet, read on!
3.2. Load and run "Blink"
The fastest method to load software onto a RP2040-based board for the first time is by mounting it as a USB Mass
Storage Device. Doing this allows you to drag a file onto the board to program the flash. Go ahead and connect the
Raspberry Pi Pico to your Raspberry Pi using a micro-USB cable, making sure that you hold down the BOOTSEL button
(Figure 1) as you do so, to force it into USB Mass Storage Mode.
3.2. Load and run "Blink"9
Page 11
Getting started with Raspberry Pi Pico
3.2.1. From the desktop
If you are running the Raspberry Pi Desktop the Raspberry Pi Pico should automatically mount as a USB Mass Storage
Device. From here, you can Drag-and-drop blink.uf2 onto the Mass Storage Device.
RP2040 will reboot, unmounting itself as a Mass Storage Device, and start to run the flashed code, see Figure 1.
Figure 1. Blinking the
on-board LED on the
Raspberry Pi Pico.
Arrows point to the onboard LED, and the
BOOTSEL button.
3.2.2. Using the command line
TIP
You can use picotool to load a UF2 binary onto your Raspberry Pi Pico, see Appendix B.
If you are logged in via ssh for example, you may have to mount the mass storage device manually:
If you can see files in /mnt/pico then the USB Mass Storage Device has been mounted correctly:
$ ls /mnt/pico/
INDEX.HTM INFO_UF2.TXT
Copy your blink.uf2 onto RP2040:
$ sudo cp blink.uf2 /mnt/pico
$ sudo sync
RP2040 has already disconnected as a USB Mass Storage Device and is running your code, but for tidiness unmount
/mnt/pico
3.2. Load and run "Blink"10
Page 12
Getting started with Raspberry Pi Pico
$ sudo umount /mnt/pico
NOTE
Removing power from the board does not remove the code. When the board is reattached to power, the code you
have just loaded will begin running again. If you want to upload new code to the board (and overwrite whatever was
already on there), press and hold the BOOTSEL button when applying power to put the board into Mass Storage
mode.
3.2.3. Aside: Other Boards
If you are not following these instructions on a Raspberry Pi Pico, you may not have a BOOTSEL button (as labelled in
Figure 1). Your board may have some other way of loading code, which the board supplier should have documented:
Most boards expose the SWD interface (Chapter 5) which can reset the board and load code without any button
•
presses
There may be some other way of pulling down the flash CS pin (which is how the BOOTSEL button works on
•
Raspberry Pi Pico), such as a pair of jumper pins which should be shorted together
Some boards will have a reset button but no BOOTSEL, and may include some code in flash to detect a double-
•
press of the reset button and enter the bootloader in this way.
In all cases you should consult the documentation for the specific board you are using, which should describe the best
way to load firmware onto that board.
3.2.4. Aside: Hands-free Flash Programming
To enter BOOTSEL mode on your Raspberry Pi Pico, and load code over USB, you need to hold the BOOTSEL button
down, and then reset the board in some way. You can do this by unplugging and plugging the USB connector, or adding
an external button to pull the RUN pin to ground.
You can also use the SWD port (Chapter 5) to reset the board, load code and set the processors running, and this works
even if your code has crashed, so there is no need to manually reset the board or press any buttons. Once you are all set
up with building programs, and you have tried the Hello World example in the next chapter (Chapter 4), setting up SWD
is a good next step.
If you are on a Raspberry Pi, you can set up SWD by running the pico-setup script (Chapter 1), and connecting 3 wires
from your Pi to the Pico as shown in Chapter 5. A USB to SWD debug probe can also be used, for example Appendix A
shows how one Pico can be used to access the SWD port of a second Pico via the first Pico’s USB port.
3.2. Load and run "Blink"11
Page 13
Getting started with Raspberry Pi Pico
Chapter 4. Saying "Hello World" in C
After blinking an LED on and off, the next thing that most developers will want to do is create and use a serial port, and
say "Hello World."
Serial input (stdin) and output (stdout) can be directed to either serial UART or to USB CDC (USB serial). However by
default stdio and printf will target the default Raspberry Pi Pico UART0.
Default UART0 Physical Pin GPIO Pin
GND3N/A
UART0_TX1GP0
UART0_RX2GP1
IMPORTANT
The default Raspberry Pi Pico UART TX pin (out from Raspberry Pi Pico) is pin GP0, and the UART RX pin (in to
Raspberry Pi Pico) is pin GP1. The default UART pins are configured on a per-board basis using board configuration
files. The Raspberry Pi Pico configuration can be found in https://github.com/raspberrypi/pico-sdk/tree/master/src/
boards/include/boards/pico.h. The SDK defaults to a board name of Raspberry Pi Pico if no other board is specified.
The SDK makes use of CMake to control its build system, see Chapter 8, making use of the pico_stdlib interface library
to aggregate necessary source files to provide capabilities.
Ê1 if (TARGET tinyusb_device)
Ê2 add_executable(hello_usb
Ê3 hello_usb.c
Ê4 )
Ê5
Ê6 # pull in common dependencies
Ê7 target_link_libraries(hello_usb pico_stdlib)
Ê8
Ê9 # enable usb output, disable uart output
10 pico_enable_stdio_usb(hello_usb 1)
11 pico_enable_stdio_uart(hello_usb 0)
12
13 # create map/bin/hex/uf2 file etc.
14 pico_add_extra_outputs(hello_usb)
15
16 # add url via pico_set_program_url
17 example_auto_set_url(hello_usb)
18 elseif(PICO_ON_DEVICE)
19 message(WARNING "not building hello_usb because TinyUSB submodule is not initialized in
Ê the SDK")
20 endif()
4.2. Build "Hello World"
As we did for the previous "Blink" example, change directory into the hello_world directory inside the pico-examples/build
tree, and run make.
$ cd hello_world
$ make -j4
Scanning dependencies of target ELF2UF2Build
[ 0%] Creating directories for 'ELF2UF2Build'
Ê .
Ê .
[ 33%] Linking CXX executable hello_usb.elf
[ 33%] Built target hello_usb
Ê .
Ê .
[100%] Linking CXX executable hello_serial.elf
[100%] Built target hello_serial
This will build two separate examples programs in the hello_world/serial/ and hello_world/usb/ directories.
4.2. Build "Hello World"13
Page 15
Getting started with Raspberry Pi Pico
Amongst other targets, we have now built:
serial/hello_serial.elf, which is used by the debugger
•
serial/hello_serial.uf2, which can be dragged onto the RP2040 USB Mass Storage Device (UART serial binary)
•
usb/hello_usb.elf, which is used by the debugger
•
usb/hello_usb.uf2, which can be dragged onto the RP2040 USB Mass Storage Device (USB serial binary)
•
Where hello_serial directs stdio to UART0 on pins GP0 and GP1, and hello_usb directs stdio to USB CDC serial.
WARNING
If you have not initialised the tinyusb submodule in your pico-sdk checkout then the USB CDC serial example will not
work as the SDK will contain no USB functionality.
4.3. Flash and Run "Hello World"
Connect the Raspberry Pi Pico to your Raspberry Pi using a micro-USB cable, making sure that you hold down the
BOOTSEL button to force it into USB Mass Storage Mode. Once it is connected release the BOOTSEL button and if you are
running the Raspberry Pi Desktop it should automatically mount as a USB Mass Storage Device. From here, you can
Drag-and-drop either the hello_serial.uf2 or hello_usb.uf2 onto the Mass Storage Device.
Figure 2. Connecting
the Raspberry Pi to
Raspberry Pi Pico via
USB.
RP2040 will reboot, unmounting itself as a Mass Storage Device, and start to run the flashed code.
However, although the "Hello World" example is now running, we cannot yet see the text. We need to connect our host
computer to the appropriate stdio interface on the Raspberry Pi Pico to see the output.
4.4. See "Hello World" USB output
If you have dragged and dropped the hello_usb.uf2 binary, then the "Hello World" text will be directed to USB serial.
With your Raspberry Pi Pico connected directly to your Raspberry Pi via USB, see Figure 2, you can see the text by
installing minicom:
4.3. Flash and Run "Hello World"14
Page 16
Getting started with Raspberry Pi Pico
$ sudo apt install minicom
and open the serial port:
$ minicom -b 115200 -o -D /dev/ttyACM0
You should see Hello, world! printed to the console.
TIP
To exit minicom, use CTRL-A followed by X.
NOTE
If you are intending to using SWD for debugging (see Chapter 6) you need to use a UART based serial connection as
the USB stack will be paused when the RP2040 cores are stopped during debugging, which will cause any attached
USB devices to disconnect.
Figure 3. Enabling a
serial UART using
raspi-config on
the Raspberry Pi.
4.5. See "Hello World" UART output
Alternatively if you dragged and dropped the hello_serial.uf2 binary, then the "Hello World" text will be directed to
UART0 on pins GP0 and GP1. The first thing you’ll need to do to see the text is enable UART serial communications on
the Raspberry Pi host. To do so, run raspi-config,
$ sudo raspi-config
and go to Interfacing Options→Serial and select "No" when asked "Would you like a login shell to be accessible over
serial?" and "Yes" when asked "Would you like the serial port hardware to be enabled?" You should see something like
Figure 3.
Leaving raspi-config you should choose "Yes" and reboot your Raspberry Pi to enable the serial port.
4.5. See "Hello World" UART output15
Page 17
Getting started with Raspberry Pi Pico
You should then wire the Raspberry Pi and the Raspberry Pi Pico together with the following mapping:
Raspberry PiRaspberry Pi Pico
GND (Pin 14)GND (Pin 3)
GPIO15 (UART_RX0, Pin 10)GP0 (UART0_TX, Pin 1)
GPIO14 (UART_TX0, Pin 8)GP1 (UART0_RX, Pin 2)
See Figure 4.
Figure 4. A Raspberry
Pi 4 and the Raspberry
Pi Pico with UART0
connected together.
Once the two boards are wired together if you have not already done so you should install minicom:
$ sudo apt install minicom
and open the serial port:
$ minicom -b 115200 -o -D /dev/serial0
You should see Hello, world! printed to the console.
TIP
To exit minicom, use CTRL-A followed by X.
4.6. Powering the board
You can unplug the Raspberry Pi Pico from USB, and power the board by additionally connecting the Raspberry Pi’s 5V
pin to the Raspberry Pi Pico VSYS pin via a diode, see Figure 5, where in the ideal case the diode would be a Schottky
diode.
4.6. Powering the board16
Page 18
Getting started with Raspberry Pi Pico
Figure 5. Raspberry Pi
and Raspberry Pi Pico
connected only using
the GPIO pins.
Whilst it is possible to connect the Raspberry Pi’s 5V pin to the Raspberry Pi Pico VBUS pin, this is not recommended.
Shorting the 5V rails together will mean that the Micro USB cannot be used. An exception is when using the Raspberry
Pi Pico in USB host mode, in this case 5V must be connected to the VBUS pin.
The 3.3V pin is an OUTPUT pin on the Raspberry Pi Pico, you cannot power the Raspberry Pi Pico via this pin, and it
should NOT be connected to a power source.
See the Power section in Hardware design with RP2040 for more information about powering the Raspberry Pi Pico.
4.6. Powering the board17
Page 19
Getting started with Raspberry Pi Pico
Chapter 5. Flash Programming with
SWD
Serial Wire Debug (SWD) is a standard interface on Cortex-M-based microcontrollers, which the machine you are using
to develop your code (commonly called the host) can use to reset the board, load code into flash, and set the code
running. Raspberry Pi Pico exposes the RP2040 SWD interface on three pins at the bottom edge of the board. The host
can use the SWD port to access RP2040 internals at any time, so there is no need to manually reset the board or hold
the BOOTSEL button.
Figure 6. The SWD
port is labelled at the
bottom of this Pico
pinout diagram. The
ground (GND)
connection is required
to maintain good
signal integrity
between the host and
the Pico. The SWDIO
pin carries debug
traffic in both
directions, between
RP2040 and the host.
The SWCLK pin keeps
the connection wellsynchronised. These
pins connect to a
dedicated SWD
interface on RP2040,
so you don’t need to
sacrifice any GPIOs to
use the SWD port.
On a Raspberry Pi, you can connect the Pi GPIOs directly to Pico’s SWD port, and load code from there. On other
machines you will need an extra piece of hardware — a debug probe — to bridge a connection on your host machine (like
a USB port) to the SWD pins on the Pico. One of the cheapest ways to do this is to use another Pico as the debug probe,
and this is covered in Appendix A.
This chapter covers how you can connect your machine to Raspberry Pi Pico’s SWD port, and use this to write programs
into flash and run them.
TIP
If you use an IDE like Visual Studio Code (Chapter 7), this can be configured to use SWD automatically behind the
scenes, so you click the play button and the code runs, as though you were running native code on your own
machine.
NOTE
You can also use SWD for interactive debugging techniques like setting breakpoints, stepping through code
execution line-by-line, or even peeking and poking IO registers directly from your machine without writing any
RP2040 software. This is covered in Chapter 6.
5.1. Installing OpenOCD
To access the SWD port on a microcontroller, you need a program on your host machine called a debug translator,
which understands the SWD protocol, and knows how to control the processor (two Cortex-M0+s in the case of
5.1. Installing OpenOCD18
Page 20
Getting started with Raspberry Pi Pico
RP2040) inside the microcontroller. The debug translator also knows how to talk to the specific debug probe that you
have connected to the SWD port, and how to program the flash on your device.
This section walks through installing a debug translator called OpenOCD.
TIP
If you have run the pico-setup script on your Raspberry Pi (Chapter 1), OpenOCD is already installed and you can skip
to the next section.
NOTE
These instructions assume you want to build openocd in /home/pi/pico/openocd
$ cd ~/pico
$ sudo apt install automake autoconf build-essential texinfo libtool libftdi-dev libusb-1.0-0dev
$ git clone https://github.com/raspberrypi/openocd.git --recursive --branch rp2040 --depth=1
$ cd openocd
$ ./bootstrap
$ ./configure --enable-ftdi --enable-sysfsgpio --enable-bcm2835gpio
$ make -j4
$ sudo make install
Figure 7. A Raspberry
Pi 4 and the Raspberry
Pi Pico with UART and
SWD port connected
together. Both are
jumpered directly back
to the Raspberry Pi 4
without using a
breadboard. Only the
lower three wires in
this diagram are
needed for SWD
access; optionally you
can also connect the
Pi UART, as shown by
the upper 3 wires, to
directly access the
Pico’s serial port.
OpenOCD should now be installed, and you can run it as openocd from your terminal.
NOTE
On macOS you may have to install a newer version of texinfo using Homebrew.
5.2. SWD Port Wiring
You need to connect wires to the SWD port in order to program and run code on RP2040 via SWD.
5.2. SWD Port Wiring19
Page 21
Getting started with Raspberry Pi Pico
The default configuration is to have SWDIO on Pi GPIO 24, and SWCLK on GPIO 25 — and can be wired to a Raspberry Pi
Pico with the following mapping,
Raspberry PiRaspberry Pi Pico
GND (Pin 20)SWD GND
GPIO24 (Pin 18)SWDIO
GPIO25 (Pin 22)SWCLK
as seen in Figure 7.
TIP
If you are using another debug probe, like Picoprobe (Appendix A), you need to connect the GND, SWCLK and SWDIO
pins on your probe to the matching pins on your Raspberry Pi Pico, or other RP2040-based board.
If possible you should wire the SWD port directly to the Raspberry Pi as signal integrity is important; wiring the SWD port
via a breadboard or other indirect methods may reduce the signal integrity sufficiently so that loading code over the
connection is erratic or fails completely. It is important to also wire the ground wire ( 0V ) between the two directly and
not rely on another ground path.
Note the Raspberry Pi Pico must also be powered (e.g. via USB) in order to debug it! You must build our OpenOCD
branch to get working multidrop SWD support.
5.3. Loading a Program
OpenOCD expects program binaries to be in the form of .elf (executable linkable format) files, not the .uf2 files used by
BOOTSEL mode. The SDK builds both types of file by default, but it’s important not to mix them up.
Assuming you have already built the blink example, using the instructions in Chapter 3, you can run the following
command to program the resulting .elf file over SWD, and run it:
There are quite a few arguments to this command, so it’s worth breaking them down:
-f interface/raspberrypi-swd.cfg
-f target/rp2040.cfgTell OpenOCD we are connecting to a RP2040-based board. This .cfg file
Tell OpenOCD to use Raspberry Pi’s GPIO pins to access the SWD port. If we
were using an external USB→SWD probe, like Picoprobe in Appendix A, we
would specify a different interface here.
contains information for OpenOCD like the type of processor (Cortex-M0+)
and how it should access the flash memory.
-c
program blink/blink.elfTell OpenOCD to write our .elf file into flash, erasing the target region of
5.3. Loading a Program20
This argument is used to pass a series of commands to OpenOCD directly
from the command line. OpenOCD also has an interactive terminal interface
which we could type the commands into instead. The commands we use
are:
flash first if necessary. The .elf file contains all the information telling
OpenOCD where different parts of it must be loaded, and how big those parts
are.
Page 22
Getting started with Raspberry Pi Pico
verify
Tell OpenOCD to read back from the flash after programming, to check that
the programming was successful.
reset
Put the RP2040 into a clean initial state, as though it had just powered up, so
that it is ready to run our code.
exit
Disconnect from the RP2040 and exit. Our freshly-programmed code will
start running once OpenOCD disconnects.
TIP
If you see an error like Info: DAP init failed then OpenOCD could not see an RP2040 on the SWD interface it used.
The most common reasons are that your board is not correctly powered via e.g. a USB cable; that the SWD wiring is
not correct (e.g. the ground wire is not connected, or SWDIO and SWCLK have been swapped); or that there is some
signal integrity issue caused by long or loose jumper wires.
To check that you really have loaded a new program, you can modify blink/blink.c to flash the LED more quickly, and
then rebuild, and rerun the openocd command above:
int main() {
Ê const uint LED_PIN = 25;
Ê gpio_init(LED_PIN);
Ê gpio_set_dir(LED_PIN, GPIO_OUT);
Ê while (true) {
Ê gpio_put(LED_PIN, 1);
Ê // Blink faster! (this is the only line that's modified)
Ê sleep_ms(25);
Ê gpio_put(LED_PIN, 0);
Ê sleep_ms(250);
Ê }
}
And then,
$ cd pico-examples/build
$ make blink
# (the application is rebuilt)
$ openocd -f interface/raspberrypi-swd.cfg -f target/rp2040.cfg -c "program blink/blink.elf
verify reset exit"
5.3. Loading a Program21
Page 23
Getting started with Raspberry Pi Pico
Chapter 6. Debugging with SWD
As well as resetting the board, loading and running code, the SWD port on RP2040-based boards like Raspberry Pi Pico
can be used to interactively debug a program you have loaded. This includes things like:
Setting breakpoints in your code
•
Stepping through execution line by line
•
Inspecting the values of variables at different points in the program
•
Chapter 5 showed how to install OpenOCD to access the SWD port on your Raspberry Pi Pico. To debug code
interactively, we also need a debugger, such as the ubiquitous GNU Debugger, GDB.
Note that by default the SDK builds highly optimised program binaries, which can look very different in terms of control
flow and dataflow from the original program you wrote. This can be confusing when you try and step through the code
interactively, so it’s often helpful to create a debug build of your program which is less aggressively optimised, so that
the real on-device control flow is a closer match to your source code.
6.1. Build "Hello World" debug version
WARNING
When using SWD for debugging you need to use a UART based serial connection (see Chapter 4) as the USB stack
will be paused when the RP2040 cores are stopped during debugging, which will cause any attached USB devices to
disconnect. You cannot use a USB CDC serial connection during debugging.
You can build a debug version of the "Hello World"" with CMAKE_BUILD_TYPE=Debug as shown below,
$ cd ~/pico/pico-examples/
$ rm -rf build
$ mkdir build
$ cd build
$ export PICO_SDK_PATH=../../pico-sdk
$ cmake -DCMAKE_BUILD_TYPE=Debug ..
$ cd hello_world/serial
$ make -j4
6.2. Installing GDB
Install gdb-multiarch,
$ sudo apt install gdb-multiarch
6.3. Use GDB and OpenOCD to debug Hello World
Ensuring your Raspberry Pi 4 and Raspberry Pi Pico are correctly wired together, we can attach OpenOCD to the chip, via
the raspberrypi-swd interface.
...
Info : rp2040.core0: hardware has 4 breakpoints, 2 watchpoints
Info : rp2040.core1: hardware has 4 breakpoints, 2 watchpoints
Info : starting gdb server for rp2040.core0 on 3333
Info : Listening on port 3333 for gdb connections
WARNING
If you see an error like Info : DAP init failed then your Raspberry Pi Pico is either powered off, wired incorrectly, or
has signal integrity issues. Try different GPIO jumper cables.
This OpenOCD terminal needs to be left open. So go ahead and open another terminal, in this one we’ll attach a gdb
instance to OpenOCD. Navigate to the "Hello World" example code, and start gdb from the command line.
$ cd ~/pico/pico-examples/build/hello_world/serial
$ gdb-multiarch hello_serial.elf
Connect GDB to OpenOCD,
(gdb) target remote localhost:3333
TIP
You can create a .gdbinit file so you don’t have to type target remote localhost:3333 every time. Do this with echo
"target remote localhost:3333" > ~/.gdbinit. However, this interferes with debugging in VSCode (Chapter 7).
If you see errors similar to Error finishing flash operation or Error erasing flash with vFlashErase packet in GDB when
attempting to load the binary onto the Raspberry Pi Pico via OpenOCD then there is likely poor signal integrity
between the Raspberry Pi and the Raspberry Pi Pico. If you are not directly connecting the SWD connection between
the two boards, see Figure 7, you should try to do that. Alternatively you can try reducing the value of adapter_khz in
the raspberrypi-swd.cfg configuration file, trying halving it until you see a successful connection between the boards.
As we’re bitbanging between the boards timing is marginal, so poor signal integrity may cause errors.
Or if you want to set a breakpoint at main() before running the executable,
(gdb) monitor reset init
(gdb) b main
(gdb) continue
Thread 1 hit Breakpoint 1, main () at /home/pi/pico/picoexamples/hello_world/serial/hello_serial.c:11
11 stdio_init_all();
before continuing after you have hit the breakpoint,
(gdb) continue
To quit from gdb type,
(gdb) quit
More information about how to use gdb can be found at https://www.gnu.org/software/gdb/documentation/.
6.3. Use GDB and OpenOCD to debug Hello World24
Page 26
Getting started with Raspberry Pi Pico
Chapter 7. Using Visual Studio Code
Visual Studio Code (VSCode) is a popular open source editor developed by Microsoft. It is the recommended Integrated
Development Environment (IDE) on the Raspberry Pi 4 if you want a graphical interface to edit and debug your code.
7.1. Installing Visual Studio Code
IMPORTANT
These installation instructions rely on you already having downloaded and installed the command line toolchain (see
Chapter 3), as well as connecting SWD to your board via OpenOCD (Chapter 5) and setting up GDB for command-line
debugging (Chapter 6).
Visual Studio Code (VSCode) can be installed in Raspberry Pi OS using the usual apt procedure:
$ sudo apt update
$ sudo apt install code
Once the install has completed, install the extensions needed to debug a Raspberry Pi Pico:
Ensure you set the PICO_SDK_PATH so that Visual Studio Code can find the SDK.
NOTE
If PICO_SDK_PATH is not set by default in your shell’s environment you will have to set it each time you open a new
Terminal window before starting VSCode, or start VSCode from the menus. You may therefore want to add it to your
.profile or .bashrc file.
NOTE
You can configure intellisense for CMake by changing the provider by toggling; View → Command Palette → C/C++:
Change Configuration Provider… → CMake Tools.
7.1. Installing Visual Studio Code25
Page 27
Getting started with Raspberry Pi Pico
7.2. Loading a Project
Go ahead and open the pico-examples folder by going to the Explorer toolbar (Ctrl + Shift + E), selecting "Open Folder,"
and navigating to, /home/pi/pico/pico-examples in the file popup. Then click "OK" to load the Folder into VSCode.
As long as the CMake Tools extension is installed, after a second or so you should see a popup in the lower right-hand
corner of the VSCode window.
Hit "Yes" to configure the project. You will then be prompted to choose a compiler, see Figure 8,
Figure 8. Prompt to
choose the correct
compiler for the
project.
and you should select GCC for arm-none-eabi from the drop down menu.
TIP
If you miss the popups, which will close again after a few seconds, you can configure the compiler by clicking on "No
Kit Selected" in the blue bottom bar of the VSCode window.
You can then either click on the "Build" button in the blue bottom bar to build all of the examples in pico-examples folder,
or click on where it says "[all]" in the blue bottom bar. This will present you with a drop down where you can select a
project. For now type in "hello_usb" and select the "Hello USB" executable. This means that VSCode will only build the
"Hello USB" example, saving compile time.
TIP
You can toggle between building "Debug" and "Release" executables by clicking on where it says "CMake: [Debug]:
Ready" in the blue bottom bar. The default is to build a "Debug" enabled executable ready for SWD debugging.
Go ahead and click on the "Build" button (with a cog wheel) in the blue bottom bar of the window. This will create the
build directory and run CMake as we did by hand in Section 3.1, before starting the build itself, see Figure 9.
7.2. Loading a Project26
Page 28
Getting started with Raspberry Pi Pico
Figure 9. Building the
pico-examples
project in Visual
Studio Code
As we did from the command line previously, amongst other targets, we have now built:
hello_usb.elf, which is used by the debugger
•
hello_usb.uf2, which can be dragged onto the RP2040 USB Mass Storage Device
•
7.3. Debugging a Project
The pico-examples repo contains an example debug configuration that will start OpenOCD, attach GDB, and finally launch
the application CMake is configured to build. Go ahead and copy this file (launch-raspberrypi-swd.json) into the pico-
examples/.vscode directory as launch.json. We also provide a settings.json file that we recommend you also copy. This
settings.json removes some potentially confusing options from the CMake plugin (including broken Debug and Run
buttons that attempt to run a Pico binary on the host).
7.3.1. Running "Hello USB" on the Raspberry Pi Pico
7.3. Debugging a Project28
Page 30
Getting started with Raspberry Pi Pico
IMPORTANT
Ensure that the example "Hello USB" code has been built as a Debug binary (CMAKE_BUILD_TYPE=Debug).
Now go to the Debug toolbar (Ctrl + Shift + D) and click the small green arrow (play button) at the top of the left-hand
window pane to load your code on the Raspberry Pi Pico and start debugging.
Figure 10. Debugging
the "Hello USB" binary
inside Visual Studio
Code
The code should now be loaded on to the Raspberry Pi Pico, and you should see the source code for "Hello USB" in the
main right-hand (upper) pane of the window. The code will start to run and it will proceed to the first breakpoint —
enabled by the runToMain directive in the launch.json file. Click on the small blue arrow (play button) at the top of this
main source code window to Continue (F5) and start the code running.
TIP
If you switch to the "Terminal" tab in the bottom right-hand pane, below the hello_usb.c code, you can use this to
open minicom inside VSCode to see the UART output from the "Hello USB" example by typing,
$ minicom -b 115200 -o -D /dev/ttyACM0
at the terminal prompt as we did before, see Section 4.4.
7.3. Debugging a Project29
Page 31
Getting started with Raspberry Pi Pico
Chapter 8. Creating your own Project
Go ahead and create a directory to house your test project sitting alongside the pico-sdk directory,
$ ls -la
total 16
drwxr-xr-x 7 aa staff 224 6 Apr 10:41 ./
drwx------@ 27 aa staff 864 6 Apr 10:41 ../
drwxr-xr-x 10 aa staff 320 6 Apr 09:29 pico-examples/
drwxr-xr-x 13 aa staff 416 6 Apr 09:22 pico-sdk/
$ mkdir test
$ cd test
Then copy the pico_sdk_import.cmake file from the external folder in your pico-sdk installation to your test project folder.
$ cp ../pico-sdk/external/pico_sdk_import.cmake .
You should now have something that looks like this,
$ ls -la
total 24
drwxr-xr-x 5 aa staff 160 6 Apr 10:46 ./
drwxr-xr-x 7 aa staff 224 6 Apr 10:41 ../
-rw-r--r--@ 1 aa staff 394 6 Apr 10:37 CMakeLists.txt
-rw-r--r-- 1 aa staff 2744 6 Apr 10:40 pico_sdk_import.cmake
-rw-r--r-- 1 aa staff 383 6 Apr 10:37 test.c
and can build it as we did before with our "Hello World" example.
$ mkdir build
$ cd build
$ export PICO_SDK_PATH=../../pico-sdk
$ cmake ..
$ make
The make process will produce a number of different files. The important ones are shown in the following table.
File extensionDescription
.binRaw binary dump of the program code and data
.elfThe full program output, possibly including debug information
.uf2The program code and data in a UF2 form that you can drag-and-drop on to the RP2040
board when it is mounted as a USB drive
.disA disassembly of the compiled binary
.hexHexdump of the compiled binary
.mapA map file to accompany the .elf file describing where the linker has arranged segments
in memory
Chapter 8. Creating your own Project31
Page 33
Getting started with Raspberry Pi Pico
NOTE
UF2 (USB Flashing Format) is a file format, developed by Microsoft, that is used for flashing the RP2040 board over
USB. More details can be found on the Microsoft UF2 Specification Repo
NOTE
To build a binary to run in SRAM, rather than Flash memory you can either setup your cmake build with
-DPICO_NO_FLASH=1 or you can add pico_set_binary_type(TARGET_NAME no_flash) to control it on a per binary basis in your
CMakeLists.txt file. You can download the RAM binary to RP2040 via UF2. For example, if there is no flash chip on
your board, you can download a binary that runs on the on-chip RAM using UF2 as it simply specifies the addresses
of where data goes. Note you can only download in to RAM or FLASH, not both.
8.1. Debugging your project
Debugging your own project from the command line follows the same processes as we used for the "Hello World"
example back in Section 6.3. Connect your Raspberry Pi and the Raspberry Pi Pico as in Figure 11.
Figure 11. A Raspberry
Pi 4 and the Raspberry
Pi Pico with UART and
SWD debug port
connected together.
Both are jumpered
directly back to the
Raspberry Pi 4 without
using a breadboard.
Then go ahead and build a debug version of your project using CMAKE_BUILD_TYPE=Debug as below,
$ cd ~/pico/test
$ rmdir build
$ mkdir build
$ cd build
$ export PICO_SDK_PATH=../../pico-sdk
$ cmake -DCMAKE_BUILD_TYPE=Debug ..
$ make
Then open up a terminal window and attach OpenOCD using the raspberrypi-swd interface.
This OpenOCD terminal needs to be left open. So go ahead and open another terminal window and start gdb-multiarch
using
$ cd ~/pico/test/build
$ gdb-multiarch test.elf
Connect GDB to OpenOCD, and load the test.elf binary into flash,
(gdb) target remote localhost:3333
(gdb) load
and then start it running,
(gdb) monitor reset init
(gdb) continue
8.2. Working in Visual Studio Code
If you want to work in Visual Studio Code rather than from the command line you can do that, see Chapter 7 for
instructions on how to configure the environment and load your new project into the development environment to let
you write and build code.
If you want to also use Visual Studio Code to debug and load your code onto the Raspberry Pi Pico you’ll need to create
a launch.json file for your project. The example launch-raspberrypi-swd.json in Chapter 7 should work. You need to copy it
into your project directory as .vscode/launch.json.
8.3. Automating project creation
The pico project generator, automatically creates a "stub" project with all the necessary files to allow it to build. If you
want to make use of this you’ll need to go ahead and clone the project creation script from its Git repository,
$ cd pico-project-generator
$ ./pico_project.py --gui
which will bring up a GUI interface allowing you to configure your project, see Figure 12.
8.2. Working in Visual Studio Code33
Page 35
Getting started with Raspberry Pi Pico
Figure 12. Creating a
RP2040 project using
the graphical project
creation tool.
You can add specific features to your project by selecting them from the check boxes on the GUI. This will ensure the
build system adds the appropriate code to the build, and also adds simple example code to the project showing how to
use the feature.
There are a number of options available, which provide the following functionality.
Console OptionsDescription
Console over UARTEnable a serial console over the UART. This is the default.
Console over USBEnable a console over the USB. The device will act as a USB serial port. This
can be used in addition to or instead of the UART option, but note that when
enabled other USB functionality is not possible.
Code OptionsDescription
Add examples for Pico libraryExample code will be generated for some of the standard library features that
by default are in the build, for example, UART support and HW dividers.
Run from RAMUsually, the build creates a binary that will be installed to the flash memory.
This forces the binary to work directly from RAM
Generate C++The source files generated will be C++ compatible.
Enable C++ exceptionsEnable C++ exceptions. Normally disabled to save code space.
Enable C++ RTTIEnable C++ Run Time Type Information. Normally disabled to save code
space.
AdvancedBrings up a table allowing selection of specific board build options. These
options alter the way the features work, and should be used with caution.
8.3. Automating project creation34
Page 36
Getting started with Raspberry Pi Pico
Build OptionsDescription
Run BuildOnce the project has been created, build it. This will produce files ready for
Overwrite ProjectIf a project already exists in the specified folder, overwrite it with the new
IDE OptionsDescription
Create VSCode ProjectAs well as the CMake files, also create the appropriate Visual Studio Code
DebuggerSelect which Pico Debugger the VSCode debugging system will use. Defaults
8.3.1. Project generation from the command line
The script also provides the ability to create a project from the command line, e.g.
download to the Raspberry Pi Pico.
project. This will overwrite any changes you may have made.
The --feature options add the appropriate library code to the build, and also example code to show basic usage of the
feature. You can add multiple features, up to the memory limitation of the RP2040. You can use the --list option of the
script to list all the available features. The example above adds support for the I2C and SPI interfaces.
Here passing the --project vscode option will mean that .vscode/launch.json, .vscode/c_cpp_properties.json and
.vscode/settings.json files are also created, in addition to the CMake project files.
Once created you can build the project in the normal way from the command line,
$ cd test/build
$ cmake ..
$ make
or from Visual Studio Code.
You can use the --help option to give a list of command line arguments, these will also be applied when using the
graphical mode.
Need more detail?
There should be enough here to show you how to get started, but you may find yourself wondering why
some of these files and incantations are needed. The Raspberry Pi Pico C/C++ SDK book dives deeper
into how your project is actually built, and how the lines in our CMakeLists.txt files here relate to the
structure of the SDK, if you find yourself wanting to know more at some future point.
8.3. Automating project creation35
Page 37
Getting started with Raspberry Pi Pico
Chapter 9. Building on other
platforms
While the main supported platform for developing for the RP2040 is the Raspberry Pi, support for other platforms, such
as Apple macOS and Microsoft Windows, is available.
9.1. Building on Apple macOS
Using macOS to build code for RP2040 is very similar to Linux.
9.1.1. Installing the Toolchain
Installation depends on Homebrew, if you don’t have Homebrew installed you should go ahead and install it,
However after that you can follow the Raspberry Pi instructions to build code for the RP2040. Once the toolchain is
installed there are no differences between macOS and Linux, so see Section 2.1 and follow the instructions from there
— skipping the section where you install the toolchain — to fetch the SDK and build the "Blink" example.
NOTE
If you are running on an Apple M1-based Mac you will need to install Rosetta 2 as the Arm compiler is still only
compiled for x86 processors and does not have an Arm native version.
Visual Studio Code (VSCode) is a cross platform environment and runs on macOS, as well as Linux, and Microsoft
Windows. Go ahead and download the macOS version, unzip it, and drag it to your Applications Folder.
Navigate to Applications and click on the icon to start Visual Studio Code.
9.1.3. Building with CMake Tools
After starting Visual Studio Code you then need to install the CMake Tools extension. Click on the Extensions icon in the
left-hand toolbar (or type Cmd + Shift + X), and search for "CMake Tools" and click on the entry in the list, and then click
9.1. Building on Apple macOS36
Page 38
Getting started with Raspberry Pi Pico
on the install button.
We now need to set the PICO_SDK_PATH environment variable. Navigate to the pico-examples directory and create a .vscode
directory and add a file called settings.json to tell CMake Tools to location of the SDK. Additionally point Visual Studio
at the CMake Tools extension.
{
Ê "cmake.environment": {
Ê "PICO_SDK_PATH":"../../pico-sdk"
Ê },
}
Now click on the Cog Wheel at the bottom of the navigation bar on the left-hand side of the interface and select
"Settings". Then in the Settings pane click on "Extensions" and the "CMake Tools configuration". Then scroll down to
"Cmake: Generator" and enter "Unix Makefiles" into the box.
NOTE
Depending on your local setup you may not need to set the CMake generator manually to "Unix Makefiles". However
if you do not do so in some cases Visual Studio will default to ninja rather than make and the build might fail as GCC
outputs dependency-information in a slightly-incorrect format that ninja can’t understand.
Figure 13. Prompt to
choose the correct
compiler for the
project.
If you do find yourself having to configure this variable manually it is also possible that you may need to point Visual
Studio at the CMake Tools extension explicitly by adding an additional line to your settings.json file,
{
Ê "cmake.environment": {
Ê "PICO_SDK_PATH": "../../pico-sdk"
Ê },
Ê "C_Cpp.default.configurationProvider": "ms-vscode.cmake-tools"
}
Then go to the File menu and click on "Add Folder to Workspace…" and navigate to pico-examples repo and click "Okay".
The project will load and you’ll (probably) be prompted to choose a compiler, see Figure 13. Select "GCC for arm-noneeabi" for your compiler.
9.1. Building on Apple macOS37
Page 39
Getting started with Raspberry Pi Pico
Finally go ahead and click on the "Build" button (with a cog wheel) in the blue bottom bar of the window. This will create
the build directory and run CMake as we did by hand in Section 3.1, before starting the build itself, see Figure 9.
This will produce elf, bin, and uf2 targets, you can find these in the hello_world/serial and hello_world/usb directories
inside the newly created build directory. The UF2 binaries can be dragged-and-dropped directly onto a RP2040 board
attached to your computer using USB.
9.1.4. Saying "Hello World"
As we did previously in Chapter 4 you can build the Hello World example with stdio routed either to USB CDC (Serial) or
to UART0 on pins GP0 and GP1. No driver installation is necessary if you’re building with USB CDC as the target output,
as it’s a class-compliant device. You just need to use a Terminal program, e.g. Serial or similar, to connect to the USB
serial port.
9.1.4.1. UART output
Alternatively if you want to you want to connect to the Raspberry Pi Pico standard UART to see the output you will need
to connect your Raspberry Pi Pico to your Mac using a USB to UART Serial converter, for example a SparkFun FTDI
Basic board, see Figure 14.
Figure 14. Sparkfun
FTDI Basic adaptor
connected to the
Raspberry Pi Pico
So long as you’re using a recent version of macOS like Catalina, the drivers should already be loaded. Otherwise see the
manufacturers' website for FTDI Chip Drivers.
Then you should use a Terminal program, e.g. Serial or similar to connect to the serial port. Serial also includes driver
support.
9.2. Building on MS Windows
Installing the toolchain on Microsoft Windows 10 is somewhat different to other platforms. However once installed,
building code for the RP2040 is somewhat similar.
9.2. Building on MS Windows38
Page 40
Getting started with Raspberry Pi Pico
TIP
While Raspberry Pi does not directly support it there is a third-party installer script for Windows 10 that is roughly
equivalent of the pico-setup.sh script for Raspberry Pi (see Chapter 1). More details at https://github.com/ndabas/
pico-setup-windows.
WARNING
Using Raspberry Pi Pico with Windows 7 or 8 is not officially supported but can be made to work.
9.2.1. Installing the Toolchain
To build you will need to install some extra tools.
Arm GNU Toolchain (you need the filename ending with -arm-none-eabi.exe)
•
CMake
•
Build Tools for Visual Studio 2022
•
Python 3.10
•
Git
•
Download the executable installer for each of these from the links above, and then carefully follow the instructions in
the following sections to install all five packages on to your Windows computer.
Figure 15. Installing
the Arm GNU
Toolchain. Ensure that
you register the path
to the compiler as an
environment variable
so that it is accessible
from the command
line.
9.2.1.1. Installing Arm GNU Toolchain
During installation you should tick the box to register the path to the Arm compiler as an environment variable in the
Windows shell when prompted to do so.
9.2.1.2. Installing CMake
9.2. Building on MS Windows39
Page 41
Getting started with Raspberry Pi Pico
Figure 16. Installing
CMake.
Figure 17. Installing
the Build Tools for
Visual Studio 2022.
During the installation add CMake to the system PATH for all users when prompted by the installer.
9.2.1.3. Installing Build Tools for Visual Studio 2022
When prompted by the Build Tools for Visual Studio installer you need to install the C++ build tools only.
9.2. Building on MS Windows40
Page 42
Getting started with Raspberry Pi Pico
NOTE
You must install the full "Windows 10 SDK" package as the SDK will need to build the pioasm and elf2uf2 tools locally.
Removing it from the list of installed items will mean that you will be unable to build Raspberry Pi Pico binaries.
9.2.1.4. Installing Python 3.10
During the installation, ensure that it’s installed 'for all users' and add Python 3.10 to the system PATH when prompted by
the installer. You should additionally disable the MAX_PATH length limit when prompted at the end of the Python
installation.
Figure 18. Installing
Python 3.10 tick the
"Add Python 3.10 to
PATH" box.
Figure 19. Installing
Git
9.2.1.5. Installing Git
When installing Git you should ensure that you change the default editor away from vim, see Figure 19.
9.2. Building on MS Windows41
Page 43
Getting started with Raspberry Pi Pico
Ensure you tick the checkbox to allow Git to be used from 3rd-party software and, unless you have a strong reason
otherwise, when installing Git you should also check the box "Checkout as is, commit as-is", select "Use Windows'
default console window", and "Enable experimental support for pseudo consoles" during the installation process.
You now need to close your current Command Prompt window and open a second Developer Command Prompt
window where this environment variable will now be set correctly before proceeding.
Navigate into the pico-examples folder, and build the 'Hello World' example as follows,
C:\Users\pico\Downloads> cd pico-examples
C:\Users\pico\Downloads\pico-examples> mkdir build
C:\Users\pico\Downloads\pico-examples> cd build
C:\Users\pico\Downloads\pico-examples\build> cmake -G "NMake Makefiles" ..
C:\Users\pico\Downloads\pico-examples\build> nmake
to build the target. This will produce elf, bin, and uf2 targets, you can find these in the hello_world/serial and
hello_world/usb directories inside your build directory. The UF2 binaries can be dragged-and-dropped directly onto a
RP2040 board attached to your computer using USB.
9.2.4. Building "Hello World" from Visual Studio Code
Now you’ve installed the toolchain you can install Visual Studio Code and build your projects inside the that environment
rather than from the command line.
Go ahead and download and install Visual Studio Code for Windows. After installation open a Developer Command
Prompt window from the Windows Menu, by selecting Windows > Visual Studio 2022 > Developer Command Prompt for VS2022
from the menu. Then type,
C:> code
at the prompt. This will open Visual Studio Code with all the correct environment variables set so that the toolchain is
correctly configured.
9.2. Building on MS Windows42
Page 44
Getting started with Raspberry Pi Pico
WARNING
If you start Visual Studio Code by clicking on its desktop icon, or directly from the Start Menu then the build
environment will not be correctly configured. Although this can be done manually later in the CMake Tools settings,
the easiest way to configure the Visual Studio Code environment is just to open it from a Developer Command
Prompt window where these environmental variables are already set.
We’ll now need to install the CMake Tools extension. Click on the Extensions icon in the left-hand toolbar (or type Ctrl +
Shift + X), and search for "CMake Tools" and click on the entry in the list, and then click on the install button.
Then click on the Cog Wheel at the bottom of the navigation bar on the left-hand side of the interface and select
"Settings". Then in the Settings pane click on "Extensions" and then "CMake Tools". Then scroll down to "Cmake:
Configure Environment". Click on "Add Item" and set the PICO_SDK_PATH to be ..\..\pico-sdk as in Figure 20.
Figure 20. Setting
PICO_SDK_PATH
Environment Variable
in the CMake
Extension
Additionally you will need to scroll down to "Cmake: Generator" and enter "NMake Makefiles" into the box.
IMPORTANT
If you do not change the "Cmake: Generator" Visual Studio will default to ninja and the build might fail as GCC
outputs dependency-information in a slightly-incorrect format that ninja can’t understand.
Now close the Settings page and go to the File menu and click on "Open Folder" and navigate to pico-examples repo and
click "Select Folder". You’ll be prompted to configure the project, see Figure 21. Select "GCC for arm-none-eabi" for your
compiler.
9.2. Building on MS Windows43
Page 45
Getting started with Raspberry Pi Pico
Figure 21. Prompt to
configure your project
in Visual Studio Code.
Go ahead and click on the "Build" button (with a cog wheel) in the blue bottom bar of the window. This will create the
build directory and run CMake and build the examples project, including "Hello World".
This will produce elf, bin, and uf2 targets, you can find these in the hello_world/serial and hello_world/usb directories
inside the newly created build directory. The UF2 binaries can be dragged-and-dropped directly onto a RP2040 board
attached to your computer using USB.
9.2.5. Flashing and Running "Hello World"
Connect the Raspberry Pi Pico to your Raspberry Pi using a micro-USB cable, making sure that you hold down the
BOOTSEL button to force it into USB Mass Storage Mode. The board should automatically appear as a external drive. You
can now drag-and-drop the UF2 binary onto the external drive.
The Raspberry Pi Pico will reboot, and unmount itself as an external drive, and start running the flashed code.
As we did in Chapter 4 you can build the Hello World example with stdio routed either to USB CDC (Serial) or to UART0
on pins GP0 and GP1. No driver installation is necessary if you’re building with USB CDC as the target output, as it’s a
class-compliant device.
9.2.5.1. UART output
Alternatively if you want to you want to connect to the Raspberry Pi Pico standard UART to see the output you will need
to connect your Raspberry Pi Pico to your computer using a USB to UART Serial converter, for example a SparkFun FTDI
Basic board, see Figure 22.
9.2. Building on MS Windows44
Page 46
Getting started with Raspberry Pi Pico
Figure 22. Sparkfun
FTDI Basic adaptor
connected to the
Raspberry Pi Pico
So long as you’re using a recent version of Windows 10, the appropriate drivers should already be loaded. Otherwise see
the manufacturers' website for FTDI Chip Drivers.
Then if you don’t already have it, download and install PuTTY. Run it, and select "Serial", enter 115,200 as the baud rate
in the "Speed" box, and the serial port that your UART converter is using. If you don’t know this you can find out using
the chgport command,
this will give you a list of active serial ports. Here the USB to UART Serial converter is on COM5.
NOTE
If you have multiple serial devices and can’t figure out which one is your UART to USB serial converter, try unplugging
your cable, and running chgport again to see which COM port disappears.
After entering the speed and port, click the "Open" button and you should see the UART output from the Raspberry Pi
Pico in your Terminal window.
9.2. Building on MS Windows45
Page 47
Getting started with Raspberry Pi Pico
Chapter 10. Using other Integrated
Development Environments
Currently the recommended Integrated Development Environment (IDE) is Visual Studio Code, see Chapter 7. However
other environments can be used with RP2040 and the Raspberry Pi Pico.
10.1. Using Eclipse
Eclipse is a multiplatform Integrated Development environment (IDE), available for x86 Linux, Windows and Mac. In
addition, the latest version is now available for 64-bit ARM systems, and works well on the Raspberry Pi 4/400 range
(4GB and up) running a 64-bit OS. The following instructions describe how to set up Eclipse on a Linux device for use
with the Raspberry Pi Pico. Instructions for other systems will be broadly similar, although connections to the Raspberry
Pi Pico will vary. See Section 9.2 and Section 9.1 for more details on non-Linux platforms.
10.1.1. Setting up Eclipse for Pico on a Linux machine
Prerequisites:
Device running a recent version of Linux with at least 4GB of RAM
•
64-bit operating system.
•
CMake 3.11 or newer
•
If using a Raspberry Pi, you should enable the standard UART by adding the following to config.txt
enable_uart=1
You should also install OpenOCD and the SWD debug system. See Chapter 5 for instructions on how to do this.
10.1.1.1. Installing Eclipse and Eclipse plugins
Install the latest version of Eclipse with Embedded CDT using the standard instructions. If you are running on an ARM
platform, you will need to install an AArch64 (64-bit ARM) version of Eclipse. All versions can be found on the Eclipse
website. https://projects.eclipse.org/projects/iot.embed-cdt/downloads
Download the correct file for your system, and extract it. You can then run it by going to the place where it was extracted
and running the 'eclipse' executable.
$ ./eclipse
The Embedded CDT version of Eclipse includes the C/C++ development kit and the Embedded development kit, so has
everything you need to develop for the Raspberry Pi Pico.
10.1.1.2. Using pico-examples
The standard build system for the Pico environment is CMake. However Eclipse does not use CMake as it has its own
build system, so we need to convert the pico-examples CMake build to an Eclipse project.
At the same level as the pico-examples folder, create a new folder, for example pico-examples-eclipse
This will create the Eclipse project files in our pico-examples-eclipse folder, using the source from the original CMake
tree.
You can now load your new project files into Eclipse using the Open project From File System option in the File menu.
10.1.1.3. Building
Figure 23. Setting the
OCD executable name
and path in Eclipse.
Right click on the project in the project explorer, and select Build. This will build all the examples.
10.1.1.4. OpenOCD
This example uses the OpenOCD system to communicate with the Raspberry Pi Pico. You will need to have provided the
2-wire debug connections from the host device to the Raspberry Pi Pico prior to running the code. On a Raspberry Pi this
can be done via GPIO connections, but on a laptop or desktop device, you will need to use extra hardware for this
connection. One way is to use a second Raspberry Pi Pico running Picoprobe, which is described in Appendix A. More
instructions on the debug connections can be found in Chapter 5.
Once OpenOCD is installed and the correct connection made, Eclipse needs to be set up to talk to OpenOCD when
programs are run. OpenOCD provides a GDB interface to Eclipse, and it is that interface that is used when debugging.
To set up the OpenOCD system, select Preferences from the Window menu.
Click on MCU arrow to expand the options and click on Global OpenOCD path.
For the executable, type in “openocd”. For the folder, select the location in the file system where you have cloned the
Pico OpenOCD fork from github.
10.1. Using Eclipse47
Page 49
Getting started with Raspberry Pi Pico
10.1.1.5. Creating a Run configuration
In order to run or debug code in Eclipse you need to set up a Run Configuration. This sets up all the information needed
to identify the code to run, any parameters, the debugger, source paths and SVD information.
From the Eclipse Run menu, select Run Configurations. To create a debugger configuration, select GDB OpenOCD Debugging
option, then select the New Configuration button.
Figure 24. Creating a
new Run/Debug
configuration in
Eclipse.
10.1.1.5.1. Setting up the application to run
Because the pico-examples build creates lots of different application executables, you need to select which specific one
is to be run or debugged.
On the Main tab of the Run configuration page, use the Browse option to select the C/C++ applications you wish to run.
The Eclipse build will have created the executables in sub folders of the Eclipse project folder. In our example case this
is
…/pico-examples-eclipse/<name of example folder>/<optional name of example subfolder>/executable.elf
So for example, if we running the LED blink example, this can be found at:
…/pico-examples-eclipse/blink/blink.elf
10.1. Using Eclipse48
Page 50
Getting started with Raspberry Pi Pico
Figure 25. Setting the
executable to debug in
Eclipse.
Figure 26. Setting up
the Debugger and
OpenOCD in Eclipse.
10.1.1.5.2. Setting up the debugger
We are using OpenOCD to talk to the Raspberry Pi Pico, so we need to set this up.
Set openocd in the Executable box and Actual Executable box. We also need to set up OpenOCD to use the Pico specific
configuration, so in the Config options sections add the following. Note you will need to change the path to point to the
location where the Pico version of OpenOCD is installed.
All other OpenOCD settings should be set to the default values.
The actual debugger used is GDB. This talks to the OpenOCD debugger for the actual communications with the
Raspberry Pi Pico, but provides a standard interface to the IDE.
The particular version of GDB used is `gdb-multiarch’, so enter this in the Executable name and Actual Executable fields.
10.1. Using Eclipse49
Page 51
Getting started with Raspberry Pi Pico
10.1.1.5.3. Setting up the SVD plugin
SVD provides a mechanism to view and set peripheral registers on the Pico board. An SVD file provides register
locations and descriptions, and the SVD plugin for Eclipse integrates that functionality in to the Eclipse IDE. The SVD
plugin comes as part of the Embedded development plugins.
Select the SVD path tab on the Launch configuration, and enter the location on the file system where the SVD file is
located. This is usually found in the pico-sdk source tree.
E.g.
…/pico-sdk/src/rp2040/hardware_regs/rp2040.svd
Figure 27. Setting the
SVD path in Eclipse.
Figure 28. The Eclipse
debugger running,
showing some of the
debugging window
available.
10.1.1.5.4. Running the Debugger
Once the Run configuration is complete and saved, you can launch immediately using the Run button at the bottom right
of the dialog, or simply Apply the changes and Close the dialog. You can then run the application using the Run Menu Debug
option.
This will set Eclipse in to debug perspective, which will display a multitude of different debug and source code windows,
along with the very useful Peripherals view which uses the SVD data to provide access to peripheral registers. From this
point on this is a standard Eclipse debugging session.
10.1. Using Eclipse50
Page 52
Getting started with Raspberry Pi Pico
10.2. Using CLion
CLion is a multiplatform Integrated Development environment (IDE) from JetBrains, available for Linux, Windows and
Mac. This is a commercial IDE often the choice of professional developers (or those who love JetBrains IDEs) although
there are free or reduce price licenses available. It will run on a Raspberry Pi, however the performance is not ideal, so it
is expected you would be using CLion on your desktop or laptop.
Whilst setting up projects, development and building are a breeze, setting up debug is still not very mainstream at the
moment, so be warned.
10.2.1. Setting up CLion
If you are planning to use CLion we assume you either have it installed or can install it from https://www.jetbrains.com/
clion/
10.2.1.1. Setting up a project
Here we are using pico-examples as the example project.
Figure 29. A newly
opened CLion picoexamples project.
To open the pico-examples project, select Open… from the File menu, and then navigate to and select the pico-examples
directory you checked out, and press OK.
Once open you’ll see something like Figure 29.
Notice at the bottom that CLion attempted to load the CMake project, but there was an error; namely that we hadn’t
specified PICO_SDK_PATH
10.2.1.1.1. Configuring CMake Profiles
Select Settings… from the File menu, and then navigate to and select 'CMake' under Build, Execution, Deployment.
You can set the environment variable PICO_SDK_PATH under Environment: as in Figure 30, or you can set it as
-DPICO_SDK_PATH=xxx under CMake options:. These are just like the environment variables or command line args when
calling cmake from the command line, so this is where you’d specify CMake settings such as PICO_BOARD,
PICO_TOOLCHAIN_PATH etc.
10.2. Using CLion51
Page 53
Getting started with Raspberry Pi Pico
Figure 30. Configuring
a CMake profile in
CLion.
You can have as many CMake profiles as you like with different settings. You probably want to add a Release build by
hitting the + button, and then filling in the PICO_SDK_PATH again, or by hitting the copy button two to the right, and
fixing the name and settings (see Figure 31)
Figure 31. Configuring
a second CMake
Profile in CLion.
After pressing OK, you’ll see something like Figure 32. Note that there are two tabs for the two profiles (Debug and
Release) at the bottom of the window. In this case Release is selected, and you can see that the CMake setup was
successful.
10.2. Using CLion52
Page 54
Getting started with Raspberry Pi Pico
Figure 32. Configuring
a second CMake
profile in CLion.
Figure 33.
hello_usb
successfully built.
10.2.1.1.2. Running a build
Now we can choose to build one or more targets. For example you can navigate to the drop down selector in the middle
of the toolbar, and select or starting typing hello_usb; then press the tool icon to its left to build (see Figure 33).
Alternatively you can do a full build of all targets or other types of build from the Build menu.
Note that the drop down selector lets you choose both the target you want to build and a CMake profile to use (in this
case one of Debug or Release)
Another thing you’ll notice Figure 33 shows is that in the bottom status bar, you can see hello_usb and Debug again.
These are showing you the target and CMake profile being used to control syntax highlighting etc. in the editor (This
was auto selected when you chose hello_usb before). You can visually see in the stdio.c file that has been opened by the
user, that PICO_STDIO_USB is set, but PICO_STDIO_UART is not (which are part of the configuration of hello_usb). Build
time per binary configuration of libraries is heavily used within the SDK, so this is a very nice feature.
10.2. Using CLion53
Page 55
Getting started with Raspberry Pi Pico
10.2.1.1.3. Build Artifacts
The build artifacts are located under cmake-build-<profile> under the project root (see Figure 34). In this case this is the
cmake-build-debug directory.
The UF2 file can be copied onto an RP2040 device in BOOTSEL mode, or the ELF can be used for debugging.
Figure 34. Locating
the hello_usb build
artifacts
10.3. Other Environments
There are many development environments available, and we cannot describe all of them here, but you will be able to
use many of them with the SDK. There are a number of things needed by your IDE that will make Raspberry Pi Pico
support possible:
CMake integration
•
GDB support with remote options
•
SVD. Not essential but makes reading peripheral status much easier
•
Optional ARM embedded development plugin. These types of plugin often make support much easier.
•
10.3.1. Using openocd-svd
The openocd-svd tool is a Python-based GUI utility that gives you access peripheral registers of ARM MCUs via
combination of OpenOCD and CMSIS-SVD.
To install it you should first install the dependencies,
If your flash has DORMANT mode code in it, or any code that stops the system clock, the debugger will fail to attach
because the system clock is stopped. While this may present as a "bricked" board you can return to BOOTSEL mode
using the button without problems.
This OpenOCD terminal needs to be left open. So go ahead and open another terminal, in this one we’ll attach a gdb
instance to OpenOCD.
This will open the openocd-svd window. Now go to the File menu and click on "Connect OpenOCD" to connect via telnet to
the running openocd instance.
This will allow you to inspect the registers of the code running on your Raspberry Pi Pico, see Figure 35.
10.3. Other Environments55
Page 57
Getting started with Raspberry Pi Pico
Figure 35. OpenOCD
SVD running and
connected to the
Raspberry Pi Pico.
10.3. Other Environments56
Page 58
Getting started with Raspberry Pi Pico
Appendix A: Using Picoprobe
One Raspberry Pi Pico can be used to reprogram and debug another, using the picoprobe firmware, which transforms a
Pico into a USB → SWD and UART bridge. This makes it easy to use a Raspberry Pi Pico on non-Raspberry Pi platforms
such as Windows, Mac, and Linux computers where you don’t have GPIOs to connect directly to UART or SWD, but you
do have a USB port.
Figure 36. Wiring
between Pico A (left)
and Pico B (right) with
Pico A acting as a
debug probe. At least
the ground and the
two SWD wires must
be connected, for one
Pico to be able to
reprogram and debug
another. This diagram
also shows how the
UART serial port can
be connected, so that
you can see the UART
serial output of the
Pico-under-test, and
how the power supply
can be bridged across,
so that both boards
are powered by one
USB cable. More in
Picoprobe Wiring.
Build OpenOCD
For picoprobe to work, you need to build openocd with the picoprobe driver enabled.
-branch
$ cd openocd
$ ./bootstrap
$ ./configure --enable-picoprobe ①
$ make -j4
$ sudo make install
1.
If you are building on a Raspberry Pi you can also pass --enable-sysfsgpio --enable-bcm2835gpio to allow bitbanging
SWD via the GPIO pins.
Build OpenOCD57
Page 59
Getting started with Raspberry Pi Pico
NOTE
Ubuntu and Debian users might additionally need to also install pkg-config.
Windows
To make building OpenOCD as easy as possible, we will use MSYS2. To quote their website: "MSYS2 is a collection of
tools and libraries providing you with an easy-to-use environment for building, installing and running native Windows
software."
Download and run the installer from https://www.msys2.org/.
Start by updating the package database and core system packages with:
$ pacman -Syu
If MSYS2 closes, start it again (making sure you select the 64-bit version) and run
Pick all when installing the mingw-w64-x86_64 toolchain by pressing enter.
Build OpenOCD58
Page 60
Getting started with Raspberry Pi Pico
Close MSYS2 and reopen the 64-bit version to make sure the environment picks up GCC.
$ git clone https://github.com/raspberrypi/openocd.git --branch rp2040 --depth=1
$ cd openocd
$ ./bootstrap
$ ./configure --enable-picoprobe --disable-werror ①
$ make -j4
1.
Unfortunately disable-werror is needed because not everything compiles cleanly on Windows
Finally run OpenOCD to check it has built correctly. Expect it to error out because no configuration options have been
passed.
$ src/openocd.exe
Open On-Chip Debugger 0.10.0+dev-gc231502-dirty (2020-10-14-14:37)
Licensed under GNU GPL v2
For bug reports, read
Ê http://openocd.org/doc/doxygen/bugs.html
embedded:startup.tcl:56: Error: Can't find openocd.cfg
in procedure 'script'
at file "embedded:startup.tcl", line 56
Info : Listening on port 6666 for tcl connections
Info : Listening on port 4444 for telnet connections
Error: Debug Adapter has to be specified, see "interface" command
embedded:startup.tcl:56: Error:
in procedure 'script'
at file "embedded:startup.tcl", line 56
The version of texinfo shipped with OSX is below the version required to build OpenOCD docs
$ cd ~/pico
$ git clone https://github.com/raspberrypi/openocd.git --branch rp2040 --depth=1
$ cd openocd
$ export PATH="/usr/local/opt/texinfo/bin:$PATH" ①
$ ./bootstrap
$ ./configure --enable-picoprobe --disable-werror ②
$ make -j4
1. Put newer version of texinfo on the path
2.
Unfortunately disable-werror is needed because not everything compiles cleanly on OSX
Check OpenOCD runs. Expect it to error out because no configuration options have been passed.
$ src/openocd
Open On-Chip Debugger 0.10.0+dev-gc231502-dirty (2020-10-15-07:48)
Licensed under GNU GPL v2
For bug reports, read
Ê http://openocd.org/doc/doxygen/bugs.html
embedded:startup.tcl:56: Error: Can't find openocd.cfg
in procedure 'script'
at file "embedded:startup.tcl", line 56
Info : Listening on port 6666 for tcl connections
Info : Listening on port 4444 for telnet connections
Error: Debug Adapter has to be specified, see "interface" command
embedded:startup.tcl:56: Error:
in procedure 'script'
at file "embedded:startup.tcl", line 56
Build and flash picoprobe
Picoprobe UF2 Download
A UF2 binary of picoprobe can be downloaded from the Software Utilities section of the Raspberry Pi
Pico documentation page. Click on the Raspberry Pi Pico section, scroll down to Software Utilities, and
download the UF2 under "Debugging using another Raspberry Pi Pico".
These build instructions assume you are running on Linux, and have installed the SDK.
$ cd ~/pico
$ git clone https://github.com/raspberrypi/picoprobe.git
$ cd picoprobe
$ mkdir build
$ cd build
$ cmake ..
Build and flash picoprobe60
Page 62
Getting started with Raspberry Pi Pico
$ make -j4
Boot the Raspberry Pi Pico you would like to act as a debugger with the BOOTSEL button pressed and drag on
picoprobe.uf2.
Picoprobe Wiring
Figure 37. Wiring
between Pico A (left)
and Pico B (right)
configuring Pico A as
a debugger. Note that
if Pico B is a USB Host
then you’d want to
hook VBUS up to VBUS
so it can provide 5V
instead of VSYS to
VSYS.
The wiring loom between the two Pico boards is shown in Figure 37.
Pico A GND -> Pico B GND
Pico A GP2 -> Pico B SWCLK
Pico A GP3 -> Pico B SWDIO
Pico A GP4/UART1 TX -> Pico B GP1/UART0 RX
Pico A GP5/UART1 RX -> Pico B GP0/UART0 TX
The minimum set of connections for loading and running code via OpenOCD is GND, SWCLK and SWDIO. Connecting up
the UART wires will also let you communicate with the right-hand Pico’s UART serial port through the left-hand Pico’s
USB connection. You can also use just the UART wires to talk to any other UART serial device, like the boot console on a
Raspberry Pi.
Optionally, to power Pico A from Pico B you should also wire,
Pico A VSYS -> Pico B VSYS
Picoprobe Wiring61
Page 63
Getting started with Raspberry Pi Pico
IMPORTANT
If Pico B is a USB Host then you must connect VBUS to VBUS, not VSYS to VSYS, so that Pico B can provide 5V on its
USB connector. If Pico B is using USB in device mode, or not using its USB at all, this is not necessary.
Install Picoprobe driver (only needed on Windows)
The Picoprobe device has two usb interfaces:
1. A class-compliant CDC UART (serial port), which means it works on Windows out of the box
2. A vendor-specific interface for SWD probe data. This means we need to install a driver to make it work.
We will use Zadig (http://zadig.akeo.ie) for this.
Download and run Zadig.
Select Picoprobe (Interface 2) from the dropdown box. Select libusb-win32 as the driver.
Then select install driver.
Using Picoprobe’s UART
Linux
$ sudo minicom -D /dev/ttyACM0 -b 115200
Install Picoprobe driver (only needed on Windows)62
Page 64
Getting started with Raspberry Pi Pico
Windows
Download and install PuTTY https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html
Open Device Manager and locate Picoprobe’s COM port number. In this example it is COM7.
Open PuTTY. Select Serial under connection type. Then type the name of your COM port along with 115200 as the
speed.
Select Open to start the serial console. You are now ready to run your application!
The picotool binary includes a command-line help function,
$ picotool help
PICOTOOL:
Ê Tool for interacting with a RP2040 device in BOOTSEL mode, or with a RP2040 binary
SYNOPSYS:
Ê picotool info [-b] [-p] [-d] [-l] [-a] [--bus <bus>] [--address <addr>] [-f] [-F]
Ê picotool info [-b] [-p] [-d] [-l] [-a] <filename> [-t <type>]
Ê picotool load [-n] [-N] [-v] [-x] <filename> [-t <type>] [-o <offset>] [--bus <bus>]
Ê [--address <addr>] [-f] [-F]
Ê picotool save [-p] [--bus <bus>] [--address <addr>] [-f] [-F] <filename> [-t <type>]
Ê picotool save -a [--bus <bus>] [--address <addr>] [-f] [-F] <filename> [-t <type>]
Ê picotool save -r <from> <to> [--bus <bus>] [--address <addr>] [-f] [-F] <filename> [-t
Ê <type>]
Ê picotool verify [--bus <bus>] [--address <addr>] [-f] [-F] <filename> [-t <type>] [-r
Ê <from> <to>] [-o <offset>]
Ê picotool reboot [-a] [-u] [--bus <bus>] [--address <addr>] [-f] [-F]
Ê picotool version [-s]
Ê picotool help [<cmd>]
COMMANDS:
Ê info Display information from the target device(s) or file.
Ê Without any arguments, this will display basic information for all connected
Ê RP2040 devices in BOOTSEL mode
Ê load Load the program / memory range stored in a file onto the device.
Ê save Save the program / memory stored in flash on the device to a file.
Ê verify Check that the device contents match those in the file.
Ê reboot Reboot the device
Ê version Display picotool version
Ê help Show general help or help for a specific command
Use "picotool help <cmd>" for more info
NOTE
The majority of commands require an RP2040 device in BOOTSEL mode to be connected.
Using picotool66
Page 68
Getting started with Raspberry Pi Pico
IMPORTANT
If you get an error message No accessible RP2040 devices in BOOTSEL mode were found. accompanied with a note similar
to Device at bus 1, address 7 appears to be a RP2040 device in BOOTSEL mode, but picotool was unable to connect
indicating that there was a Raspberry Pi Pico connected then you can run picotool using sudo, e.g.
$ sudo picotool info -a
If you get this message on Windows you can add a driver similarly to a driver for picoprobe described in Install
Picoprobe driver (only needed on Windows).
As of version 1.1 of picotool it is also possible to interact with RP2040 devices that are not in BOOTSEL mode, but are
using USB stdio support from the SDK by using the -f argument of picotool.
Display information
So there is now Binary Information support in the SDK which allows for easily storing compact information that picotool
can find (See Binary Information below). The info command is for reading this information.
The information can be either read from one or more connected RP2040 devices in BOOTSEL mode, or from a file. This
file can be an ELF, a UF2 or a BIN file.
$ picotool help info
INFO:
Ê Display information from the target device(s) or file.
Ê Without any arguments, this will display basic information for all connected RP2040 devices
Ê in BOOTSEL mode
SYNOPSYS:
Ê picotool info [-b] [-p] [-d] [-l] [-a] [--bus <bus>] [--address <addr>] [-f] [-F]
Ê picotool info [-b] [-p] [-d] [-l] [-a] <filename> [-t <type>]
OPTIONS:
Ê Information to display
Ê -b, --basic
Ê Include basic information. This is the default
Ê -p, --pins
Ê Include pin information
Ê -d, --device
Ê Include device information
Ê -l, --build
Ê Include build attributes
Ê -a, --all
Ê Include all information
TARGET SELECTION:
Ê To target one or more connected RP2040 device(s) in BOOTSEL mode (the default)
Ê --bus <bus>
Ê Filter devices by USB bus number
Ê --address <addr>
Ê Filter devices by USB device address
Ê -f, --force
Ê Force a device not in BOOTSEL mode but running compatible code to reset so the
Ê command can be executed. After executing the command (unless the command itself is
Ê a 'reboot') the device will be rebooted back to application mode
Ê -F, --force-no-reboot
Ê Force a device not in BOOTSEL mode but running compatible code to reset so the
Ê command can be executed. After executing the command (unless the command itself is
Ê a 'reboot') the device will be left connected and accessible to picotool, but
Using picotool67
Page 69
Getting started with Raspberry Pi Pico
Ê without the RPI-RP2 drive mounted
Ê To target a file
Ê <filename>
Ê The file name
Ê -t <type>
Ê Specify file type (uf2 | elf | bin) explicitly, ignoring file extension
For example connect your Raspberry Pi Pico to your computer as mass storage mode, by pressing and holding the
BOOTSEL button before plugging it into the USB. Then open up a Terminal window and type,
$ sudo picotool info
Program Information
Êname: hello_world
Êfeatures: stdout to UART
or,
$ sudo picotool info -a
Program Information
Êname: hello_world
Êfeatures: stdout to UART
Êbinary start: 0x10000000
Êbinary end: 0x1000606c
Fixed Pin Information
Ê20: UART1 TX
Ê21: UART1 RX
Build Information
Êbuild date: Dec 31 2020
Êbuild attributes: Debug build
Device Information
Êflash size: 2048K
ÊROM version: 2
for more information. Alternatively you can just get information on the pins used as follows,
$ sudo picotool info -bp
Program Information
Êname: hello_world
Êfeatures: stdout to UART
Fixed Pin Information
Ê20: UART1 TX
Ê21: UART1 RX
The tool can also be used on binaries still on your local filesystem,
$ picotool info -a lcd_1602_i2c.uf2
File lcd_1602_i2c.uf2:
Save allows you to save a range of memory or a program or the whole of flash from the device to a BIN file or a UF2 file.
$ picotool help save
SAVE:
Ê Save the program / memory stored in flash on the device to a file.
SYNOPSYS:
Ê picotool save [-p] [--bus <bus>] [--address <addr>] [-f] [-F] <filename> [-t <type>]
Ê picotool save -a [--bus <bus>] [--address <addr>] [-f] [-F] <filename> [-t <type>]
Ê picotool save -r <from> <to> [--bus <bus>] [--address <addr>] [-f] [-F] <filename> [-t
Ê <type>]
OPTIONS:
Ê Selection of data to save
Ê -p, --program
Ê Save the installed program only. This is the default
Ê -a, --all
Ê Save all of flash memory
Ê -r, --range
Ê Save a range of memory. Note that UF2s always store complete 256 byte-aligned
Ê blocks of 256 bytes, and the range is expanded accordingly
Ê <from>
Ê The lower address bound in hex
Ê <to>
Ê The upper address bound in hex
Ê Source device selection
Ê --bus <bus>
Ê Filter devices by USB bus number
Ê --address <addr>
Ê Filter devices by USB device address
Ê -f, --force
Ê Force a device not in BOOTSEL mode but running compatible code to reset so the
Ê command can be executed. After executing the command (unless the command itself is
Ê a 'reboot') the device will be rebooted back to application mode
Ê -F, --force-no-reboot
Ê Force a device not in BOOTSEL mode but running compatible code to reset so the
Ê command can be executed. After executing the command (unless the command itself is
Ê a 'reboot') the device will be left connected and accessible to picotool, but
Ê without the RPI-RP2 drive mounted
Ê File to save to
Ê <filename>
Ê The file name
Ê -t <type>
Ê Specify file type (uf2 | elf | bin) explicitly, ignoring file extension
Using picotool69
Page 71
Getting started with Raspberry Pi Pico
For example,
$ sudo picotool info
Program Information
name: lcd_1602_i2c
web site: https://github.com/raspberrypi/pico-examples/tree/HEAD/i2c/lcd_1602_i2c
$ picotool save spoon.uf2
Saving file: [==============================] 100%
Wrote 51200 bytes to spoon.uf2
$ picotool info spoon.uf2
File spoon.uf2:
Program Information
name: lcd_1602_i2c
web site: https://github.com/raspberrypi/pico-examples/tree/HEAD/i2c/lcd_1602_i2c
Binary Information
Binary information is machine-locatable and generally machine-consumable. I say generally because anyone can
include any information, and we can tell it from ours, but it is up to them whether they make their data self-describing.
Basic information
This information is really handy when you pick up a Pico and don’t know what is on it!
Basic information includes
program name
•
program description
•
program version string
•
program build date
•
program url
•
program end address
•
program features, this is a list built from individual strings in the binary, that can be displayed (e.g. we will have one
•
for UART stdio and one for USB stdio) in the SDK
build attributes, this is a similar list of strings, for things pertaining to the binary itself (e.g. Debug Build)
•
Pins
This is certainly handy when you have an executable called hello_serial.elf but you forgot what RP2040-based board it
was built for, as different boards may have different pins broken out.
Static (fixed) pin assignments can be recorded in the binary in very compact form:
$ picotool info --pins sprite_demo.elf
File sprite_demo.elf:
Fixed Pin Information
0-4: Red 0-4
6-10: Green 0-4
11-15: Blue 0-4
16: HSync
The two pin numbers, and the function UART are stored, then decoded to their actual function names (UART1 TX etc) by
picotool. The bi_decl_if_func_used makes sure the binary information is only included if the containing function is called.
Equally, the video code contains a few lines like this:
Program Information
Êname: test
Êdescription: This is a test binary.
Êfeatures: stdout to UART
Êbinary start: 0x10000000
Êbinary end: 0x100031f8
Fixed Pin Information
Ê0: UART0 TX
Ê1: UART0 RX
Ê25: On-board LED
Build Information
Êbuild date: Jan 4 2021
shows our information strings in the output.
Setting common fields from CMake
You can also set fields directly from your project’s CMake file, e.g.,
pico_set_program_name(foo "not foo") ①
pico_set_program_description(foo "this is a foo")
pico_set_program_version_string(foo "0.00001a")
pico_set_program_url(foo "www.plinth.com/foo")
1. The name "foo" would be the default.
NOTE
All of these are passed as command line arguments to the compilation, so if you plan to use quotes, newlines etc.
you may have better luck defining it using bi_decl in the code.
Binary Information73
Page 75
Getting started with Raspberry Pi Pico
Appendix C: Documentation Release
History
Table 1.
Documentation
Release History
ReleaseDateDescription
1.021 Jan 2021
1.126 Jan 2021
1.201 Feb 2021
1.323 Feb 2021
Initial release
•
Minor corrections
•
Extra information about using DMA with ADC
•
Clarified M0+ and SIO CPUID registers
•
Added more discussion of Timers
•
Update Windows and macOS build instructions
•
Renamed books and optimised size of output PDFs
•
Minor corrections
•
Small improvements to PIO documentation
•
Added missing TIMER2 and TIMER3 registers to DMA
•
Explained how to get MicroPython REPL on UART
•
To accompany the V1.0.1 release of the C SDK
•
Minor corrections
•
Changed font
•
Additional documentation on sink/source limits for RP2040
•
Major improvements to SWD documentation
•
Updated MicroPython build instructions
•
MicroPython UART example code
•
Updated Thonny instructions
•
Updated Project Generator instructions
•
Added a FAQ document
•
Added errata E7, E8 and E9
•
1.3.105 Mar 2021
1.407 Apr 2021
Appendix C: Documentation Release History74
Minor corrections
•
To accompany the V1.1.0 release of the C SDK
•
Improved MicroPython UART example
•
Improved Pinout diagram
•
Minor corrections
•
Added errata E10
•
Note about how to update the C SDK from Github
•
To accompany the V1.1.2 release of the C SDK
•
Page 76
Getting started with Raspberry Pi Pico
ReleaseDateDescription
1.4.113 Apr 2021
1.507 Jun 2021
1.623 Jun 2021
1.6.130 Sep 2021
1.703 Nov 2021
Minor corrections
•
Clarified that all source code in the documentation is under the
•
3-Clause BSD license.
Minor updates and corrections
•
Updated FAQ
•
Added SDK release history
•
To accompany the V1.2.0 release of the C SDK
•
Minor updates and corrections
•
ADC information updated
•
Added errata E11
•
Minor updates and corrections
•
Information about B2 release
•
Updated errata for B2 release
•
Minor updates and corrections
•
Fixed some register access types and descriptions
•
Added core 1 launch sequence info
•
Described SDK "panic" handling
•
Updated picotool documentation
•
Additional examples added to Appendix A: App Notes appendix
•
in the Raspberry Pi Pico C/C++ SDK book
1.7.104 Nov 2021
1.817 Jun 2022
To accompany the V1.3.0 release of the C SDK
•
Minor updates and corrections
•
Better documentation of USB double buffering
•
Picoprobe branch changes
•
Updated links to documentation
•
Minor updates and corrections
•
Updated setup instructions for Windows in Getting started with
•
Raspberry Pi Pico
Additional explanation of SDK configuration
•
RP2040 now qualified to -40°C, minimum operating temperature
•
changed from -20°C to -40°C
Increased PLL min VCO from 400MHz to 750MHz for improved
•
stability across operating conditions
Added reflow-soldering temperature profile
•
Added errata E12, E13 and E14
•
To accompany the V1.3.1 release of the C SDK
•
Appendix C: Documentation Release History75
Page 77
Getting started with Raspberry Pi Pico
The latest release can be found at https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf.
Appendix C: Documentation Release History76
Page 78
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.