Getting Started with the Raspberry Pi Pico C/C++ SDK and TinyUSB MIDI

Kevin

Oct 4

I've been meaning to take a proper look at the Raspberry Pi Pico C/C++ SDK for quite some time, but have been putting it off. With good reason it would appear! But I've finally got to the start of being able to build the Tiny USB test MIDI application myself and so have a good template for moving forward now.

This are the "notes to self" for what I had to do to get up and running, and most importantly, which parts of the documentation were key to getting it all working.

Warning! I strongly recommend using old or second hand equipment for your experiments. I am not responsible for any damage to expensive instruments!

These are the key tutorials for the main concepts used in this project:

The C/C++ SDK
Getting Started with the Raspberry Pi Pico: C/C++ development with Raspberry Pi Pico and other RP2040 based microcontroller boards.
Raspberry Pi Pico C/C++ SDK: Libraries and tools for C/C++ development on RP2040 microcontrollers

If you are new to microcontrollers, see the Getting Started pages.

Parts list

Raspberry Pi Pico
Linux (Ubuntu) installation or virtual machine

Installation

All these instructions assume a Linux-based host. I'm using Ubuntu in a virtual machine. I followed the instructions in the Getting Started with the Raspberry Pi Pico guide.

Notes:

I didn't use the "pico_setup.sh" script described in Chapter 1 of the guide.
I followed the instructions in Chapter 2, which helps me understand a little more what is going on:
- Get the SDK and the examples using GitHub.
- Install the toolchain using apt.
Build the examples as described in Chapter 3, which helps to verify that everything is installed correctly:
- Create a build directory.
- set the PICO_SDK_PATH environment variable.
- run cmake to create the build environment.
- run make to perform the build.
I've then skipped chapter 4, 5, and 6 for now. Console output and debugging will be important so I'll come back to those later, but I'm not fussed about using Visual Studio.
Now I'm ready to create a project with the environment set up ready to go.

First Tiny USB MIDI Project

There is an example Tiny USB project that builds a MIDI USB device, so I thought I'd start with that. However there is an issue:

All of the Tiny USB examples have a slightly odd build configuration, being designed to be built from within Tiny USB which itself lives within the pico-sdk structure.
There are some Raspberry Pi Pico USB examples, but they don't transfer out of the "pico-examples" area and build as stand-alone projects.

So you have to follow the instructions in Chapter 7 of the guide to turn the Tiny USB MIDI example into a Raspberry Pi Pico example into a stand-alone "external" project. This means doing the following:

Create a project area for your new project. I have everything Pico installed in a pico area, so I've created a pico/src area for my own projects.
Copy the following files from pico/pico-sdk/lib/tinyusb/examples/device/midi_test/src:
- main.c, tusb_config.h, usb_descriptors.c
Create a file CMakeLists.txt with the following in it:

cmake_minimum_required(VERSION 3.13) include(pico_sdk_import.cmake) project(picomiditest) pico_sdk_init() add_executable(picomiditest) target_sources(picomiditest PUBLIC     ${CMAKE_CURRENT_LIST_DIR}/main.c     ${CMAKE_CURRENT_LIST_DIR}/usb_descriptors.c )  # Make sure TinyUSB can find tusb_config.h target_include_directories(picomiditest PUBLIC ${CMAKE_CURRENT_LIST_DIR})  # In addition to pico_stdlib required for common PicoSDK functionality, add dependency on tinyusb_device # for TinyUSB device support and tinyusb_board for the additional board support library used by the example target_link_libraries(picomiditest PUBLIC pico_stdlib tinyusb_device tinyusb_board)  # Uncomment this line to enable fix for Errata RP2040-E5 (the fix requires use of GPIO 15) #target_compile_definitions(picomidirouter PUBLIC PICO_RP2040_USB_DEVICE_ENUMERATION_FIX=1)  pico_add_extra_outputs(picomiditest)

This is based on the CMakeLists.txt file from the pico/pico-examples/usb/device/dev_hid_composite/CMakeLists.txt file, but with the extra entries needed, as described in Chapter 7 of the guide, to make it build outside of the pico-examples area. Basically this means the "include(pico_sdk_import.cmake)" and "pico_sdk_init()" lines. Without these, nothing will build. Everywhere you see "picomiditest", I'm assuming that is the name of the project directory, the project itself and your build output. I think they might need to all match, but I'm not sure.

Note copy over the pico_sdk_import.cmake file from pico/pico-sdk/external/ and finally create a build directory.

Your project area should now look something like this:

pico/src/picomiditest/      +--- build      +--- CMakeLists.txt      +--- main.c      +--- pico_sdk_import.cmake      +--- tusb_config.h      +--- usb_descriptors.c

Now the following steps are required.

Create the build environment using cmake.
Build the application.
Plug in a Pico with the boot button pressed.
Copy the resulting picomiditest.uf2 file over to a Raspberry Pi Pico.

$ cd pico/src/picomiditest $ export PICO_SDK_PATH=../../pico-sdk $ cd build $ cmake .. $ make $ cp picomiditest.uf2 /media/RPI_RP2/ $

If all goes well the Pico will come up blinking the LED and if you fire up a MIDI application you should see a Tiny USB device and if you connect to it as a MIDI input you should start receiving MIDI note messages.

Closing Thoughts

I had an initial go at this a number of weeks back, but got stuck trying to setup the CMakeLists.txt file to allow the build system to find all the bits and pieces. The crucial missing bit of information for me was the fact that the examples won't build outside of the examples area due to extra layers of make information.

As I was attempting to work my way through the Getting Started Guide but with my own application, nothing was working. What I hadn't realised was that the information I needed I hadn't got to yet. I hadn't noticed that Chapter 7 was dedicated to "Creating your own project".

Just a small note in the example CMakeList.txt files that they are not "stand alone" would have probably been all I needed. Oh well, now I know and hopefully this blog may help someone else getting going too.

Having spent some time searching online, I've not found anything other than "you're on your own" messages and posts in response to trying to build Tiny USB examples on the Pico. Whilst frustrating to get there, in the end all the information you'll need is around and actually it isn't too bad!

This is now a good baseline from which I can start building some custom applications. My starting point will be something for my Pico MIDI Router.

Kevin

Comment