micropython/ports/rp2
Jim Mussared e359b077dd ports: Add board.json for all boards.
This will be used by https://micropython.org/download/ to generate the
full listing of boards and firmware files.

Optionally supports a board.md for additional customisation of the
download page, as well as deploy.md for flashing instructions.

Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2021-10-27 14:04:53 +11:00
..
boards ports: Add board.json for all boards. 2021-10-27 14:04:53 +11:00
modules rp2/rp2_pio: Add fifo_join support for PIO. 2021-04-17 00:45:38 +10:00
CMakeLists.txt rp2: Add framework for networking. 2021-09-19 23:20:13 +10:00
Makefile rp2/Makefile: Add "submodules" target, to match other ports. 2021-08-19 22:54:57 +10:00
README.md rp2/Makefile: Add "submodules" target, to match other ports. 2021-08-19 22:54:57 +10:00
fatfs_port.c rp2: Enable VfsFat class for FAT filesystem support. 2021-03-11 17:56:21 +11:00
machine_adc.c rp2/machine_adc: Only initialise the ADC periph if not already enabled. 2021-02-04 10:55:43 +11:00
machine_i2c.c rp2/machine_i2c: Allow boards to configure I2C pins using new macros. 2021-07-19 23:16:11 +10:00
machine_pin.c all: Update to point to files in new shared/ directory. 2021-07-12 17:08:10 +10:00
machine_pwm.c extmod/machine_pwm: Factor out machine.PWM bindings to common code. 2021-09-04 16:31:17 +10:00
machine_rtc.c all: Update to point to files in new shared/ directory. 2021-07-12 17:08:10 +10:00
machine_spi.c rp2/machine_spi: Allow boards to configure SPI pins using new macros. 2021-07-19 23:16:11 +10:00
machine_timer.c rp2: Add new port to Raspberry Pi RP2 microcontroller. 2021-01-30 00:42:29 +11:00
machine_uart.c rp2/machine_uart: Fix read when FIFO has chars but ringbuf doesn't. 2021-07-25 17:48:50 +10:00
machine_wdt.c rp2: Add new port to Raspberry Pi RP2 microcontroller. 2021-01-30 00:42:29 +11:00
main.c rp2: Add framework for networking. 2021-09-19 23:20:13 +10:00
memmap_mp.ld rp2/memmap_mp.ld: Update for latest SDK. 2021-02-02 10:59:10 +11:00
modmachine.c extmod/machine_pwm: Factor out machine.PWM bindings to common code. 2021-09-04 16:31:17 +10:00
modmachine.h extmod/machine_pwm: Factor out machine.PWM bindings to common code. 2021-09-04 16:31:17 +10:00
modrp2.c rp2: Add new port to Raspberry Pi RP2 microcontroller. 2021-01-30 00:42:29 +11:00
modrp2.h rp2: Add new port to Raspberry Pi RP2 microcontroller. 2021-01-30 00:42:29 +11:00
moduos.c rp2/moduos: Implement uos.urandom(). 2021-04-09 18:24:38 +10:00
modutime.c all: Update to point to files in new shared/ directory. 2021-07-12 17:08:10 +10:00
mpbthciport.c rp2: Add support for bluetooth module using NimBLE. 2021-09-19 23:09:59 +10:00
mpbthciport.h rp2: Add support for bluetooth module using NimBLE. 2021-09-19 23:09:59 +10:00
mpconfigport.h rp2: Add framework for networking. 2021-09-19 23:20:13 +10:00
mphalport.c all: Update to point to files in new shared/ directory. 2021-07-12 17:08:10 +10:00
mphalport.h rp2: Add new port to Raspberry Pi RP2 microcontroller. 2021-01-30 00:42:29 +11:00
mpnimbleport.c rp2: Add support for bluetooth module using NimBLE. 2021-09-19 23:09:59 +10:00
mpnimbleport.h rp2: Add support for bluetooth module using NimBLE. 2021-09-19 23:09:59 +10:00
mpthreadport.c rp2/mpthreadport: Add mp_thread_deinit to reset core1 on soft reset. 2021-05-09 00:08:30 +10:00
mpthreadport.h rp2/mpthreadport: Add mp_thread_deinit to reset core1 on soft reset. 2021-05-09 00:08:30 +10:00
qstrdefsport.h rp2: Add new port to Raspberry Pi RP2 microcontroller. 2021-01-30 00:42:29 +11:00
rp2_flash.c rp2/rp2_flash: Disable IRQs while calling flash_erase/program. 2021-08-29 12:15:01 +10:00
rp2_pio.c all: Update to point to files in new shared/ directory. 2021-07-12 17:08:10 +10:00
tusb_config.h rp2/tusb_config.h: Set CFG_TUD_CDC_EP_BUFSIZE to 256. 2021-07-08 13:20:53 +10:00
tusb_port.c rp2/tusb_port: Allow boards to configure USB VID and PID. 2021-08-01 10:51:24 +10:00
uart.c all: Rename mp_keyboard_interrupt to mp_sched_keyboard_interrupt. 2021-04-30 15:13:43 +10:00
uart.h rp2: Add new port to Raspberry Pi RP2 microcontroller. 2021-01-30 00:42:29 +11:00

README.md

The RP2 port

This is a port of MicroPython to the Raspberry Pi RP2 series of microcontrollers. Currently supported features are:

  • REPL over USB VCP, and optionally over UART (on GP0/GP1).
  • Filesystem on the internal flash, using littlefs2.
  • Support for native code generation and inline assembler.
  • utime module with sleep, time and ticks functions.
  • uos module with VFS support.
  • machine module with the following classes: Pin, ADC, PWM, I2C, SPI, SoftI2C, SoftSPI, Timer, UART, WDT.
  • rp2 module with programmable IO (PIO) support.

See the examples/rp2/ directory for some example code.

Building

The MicroPython cross-compiler must be built first, which will be used to pre-compile (freeze) built-in Python code. This cross-compiler is built and run on the host machine using:

$ make -C mpy-cross

This command should be executed from the root directory of this repository. All other commands below should be executed from the ports/rp2/ directory.

Building of the RP2 firmware is done entirely using CMake, although a simple Makefile is also provided as a convenience. To build the firmware run (from this directory):

$ make submodules
$ make clean
$ make

You can also build the standard CMake way. The final firmware is found in the top-level of the CMake build directory (build by default) and is called firmware.uf2.

Deploying firmware to the device

Firmware can be deployed to the device by putting it into bootloader mode (hold down BOOTSEL while powering on or resetting) and then copying firmware.uf2 to the USB mass storage device that appears.

If MicroPython is already installed then the bootloader can be entered by executing import machine; machine.bootloader() at the REPL.

Sample code

The following samples can be easily run on the board by entering paste mode with Ctrl-E at the REPL, then cut-and-pasting the sample code to the REPL, then executing the code with Ctrl-D.

Blinky

This blinks the on-board LED on the Pico board at 1.25Hz, using a Timer object with a callback.

from machine import Pin, Timer
led = Pin(25, Pin.OUT)
tim = Timer()
def tick(timer):
    global led
    led.toggle()

tim.init(freq=2.5, mode=Timer.PERIODIC, callback=tick)

PIO blinky

This blinks the on-board LED on the Pico board at 1Hz, using a PIO peripheral and PIO assembler to directly toggle the LED at the required rate.

from machine import Pin
import rp2

@rp2.asm_pio(set_init=rp2.PIO.OUT_LOW)
def blink_1hz():
    # Turn on the LED and delay, taking 1000 cycles.
    set(pins, 1)
    set(x, 31)                  [6]
    label("delay_high")
    nop()                       [29]
    jmp(x_dec, "delay_high")

    # Turn off the LED and delay, taking 1000 cycles.
    set(pins, 0)
    set(x, 31)                  [6]
    label("delay_low")
    nop()                       [29]
    jmp(x_dec, "delay_low")

# Create StateMachine(0) with the blink_1hz program, outputting on Pin(25).
sm = rp2.StateMachine(0, blink_1hz, freq=2000, set_base=Pin(25))
sm.active(1)

See the examples/rp2/ directory for further example code.