framework_inputmodule: Add new rp2040 based board #8233

JohnAZoidberg · 2023-07-29T15:37:08Z

I'm just experimenting with circuitpython and I thought it would be fun to add support for our upcoming keyboard and LED matrix modules.

One thing I can't figure out is how to get the CIRCUITPY drive to pop up.
So far I'm only able to interact using the repl. It works to turn on the capslock LED and PWM backlight brightness.

Hardware: https://github.com/FrameworkComputer/inputmodules

ports/raspberrypi/fwk_keyboard/mpconfigboard.mk

dhalbert · 2023-07-29T15:49:51Z

ports/raspberrypi/fwk_keyboard/mpconfigboard.h

+//#define BOARD_FLASH_SIZE (FLASH_SIZE - 0x4000 - CIRCUITPY_INTERNAL_NVM_SIZE)
+
+// External flash W25Q80DV
+#define EXTERNAL_FLASH_QSPI_DUAL
+#if QSPI_FLASH_FILESYSTEM
+//#define MICROPY_QSPI_DATA0                NRF_GPIO_PIN_MAP(1, 00)
+//#define MICROPY_QSPI_DATA1                NRF_GPIO_PIN_MAP(0, 21)
+//#define MICROPY_QSPI_DATA2                NRF_GPIO_PIN_MAP(0, 22)
+//#define MICROPY_QSPI_DATA3                NRF_GPIO_PIN_MAP(0, 23)
+//#define MICROPY_QSPI_SCK                  NRF_GPIO_PIN_MAP(0, 19)
+//#define MICROPY_QSPI_CS                   NRF_GPIO_PIN_MAP(0, 20)
+#endif
+
+#define CIRCUITPY_DRIVE_LABEL "CIRCUITPY"
+#define CIRCUITPY_BOOT_COUNTER 1
+#define FLASH_SIZE                  (0x100000)
+#define FLASH_PAGE_SIZE             (0x4000)
+
+#define BOARD_HAS_CRYSTAL 1
+


Suggested change

//#define BOARD_FLASH_SIZE (FLASH_SIZE - 0x4000 - CIRCUITPY_INTERNAL_NVM_SIZE)

// External flash W25Q80DV

#define EXTERNAL_FLASH_QSPI_DUAL

#if QSPI_FLASH_FILESYSTEM

//#define MICROPY_QSPI_DATA0 NRF_GPIO_PIN_MAP(1, 00)

//#define MICROPY_QSPI_DATA1 NRF_GPIO_PIN_MAP(0, 21)

//#define MICROPY_QSPI_DATA2 NRF_GPIO_PIN_MAP(0, 22)

//#define MICROPY_QSPI_DATA3 NRF_GPIO_PIN_MAP(0, 23)

//#define MICROPY_QSPI_SCK NRF_GPIO_PIN_MAP(0, 19)

//#define MICROPY_QSPI_CS NRF_GPIO_PIN_MAP(0, 20)

#endif

#define CIRCUITPY_DRIVE_LABEL "CIRCUITPY"

#define CIRCUITPY_BOOT_COUNTER 1

#define FLASH_SIZE (0x100000)

#define FLASH_PAGE_SIZE (0x4000)

#define BOARD_HAS_CRYSTAL 1

You can delete all this.

Take a look at other existing RP2040 boards, such as KB2040 and QT Py RP2040.

Initially I copied it from the QT Py RP2040. But the flash chip is different. So that config won't even run.
Once I change the flash chip description to the correct one, it runs but there's no folder.

Do other boards show CIRCUITPY? (Just making sure there's nothing weird about your host system.)

Do take away the lines above; they are for an nRF board, and maybe some other things, not RP2040. Your mpconfigboard.h should look at a lot the Feather or QT Py RP2040.

You can try re-creating CIRCUITPY from the REPL:

import storage storage.erase_filesystem()

but I'm thinking there might be something else wrong.

I think the W25Q80DV chip is 8Mbit = 1 megabyte.

By default, CircuitPython allocates the first 1MB for the firmware and the remaining portion for the CIRCUITPY drive. In this case, that means there's no left over space, so the CIRCUITPY drive can't be formatted or mounted.

You can check out the raspberry pi pico w board definition for how to change this default. That board allocates a LARGER space for the firmware. You would try allocating LESS such as 900*1024 (900k), as the size of the english-language raspberry pi pico circuitpython firmware seems to be about 804kB at the moment.

(if your hardware design is not finalized, I'd urge you to consider upgrading to a 16Mbit / 2MByte flash part if possible)

here are the relevant bits from ports/raspberrypi/boards/raspberry_pi_pico_w:
mpconfigboard.mk:

# Must be accompanied by a linker script change CFLAGS += -DCIRCUITPY_FIRMWARE_SIZE='(1536 * 1024)'

link.ld:

firmware_size = 1532k;

Do other boards show CIRCUITPY? (Just making sure there's nothing weird about your host system.)

Yep. QT Py 2040 works.

By default, CircuitPython allocates the first 1MB for the firmware and the remaining portion for the CIRCUITPY drive. In this case, that means there's no left over space, so the CIRCUITPY drive can't be formatted or mounted.

Ohh thanks. Yeah that must be it. Currently our flash size is only 1M. I'll try it later.

It's not really a dev board, so it's not a priority to run circuitpython. But we want to enable users to write their own firmware. We'll take it into consideration.

The boards are not meant for general purpose IO, so we don't need many of the circuitpy modules.
I removed a bunch of them to get the fw size below 512K. Now there's plenty of space for the CIRCUITPY drive and it does work!

Can I also limit the maximum size of the CIRCUITPY drive? It doesn't seem quite as straight forward. And the code comments say it expects at least 2M of flash to work.
My reason is that we put the serial number in the last sector of flash 1M-4096B. We'll lock this sector but I'm afraid the circuitpy drive might not handle this properly.

We do this for the Teensy 4.x as well. I think we use a linker script setting there. On RP2040 we'll likely want a compile time option because RP2040 CP detects flash size automatically.

If you need a tester, I'm very interested in a Framework laptop. :-)

Signed-off-by: Daniel Schaefer <dhs@frame.work>

Memory region Used Size Region Size %age Used FLASH_FIRMWARE: 472304 B 512 KB 90.08% RAM: 45952 B 256 KB 17.53% SCRATCH_Y: 0 GB 4 KB 0.00% SCRATCH_X: 2 KB 4 KB 50.00% Signed-off-by: Daniel Schaefer <dhs@frame.work>

JohnAZoidberg · 2023-08-02T05:39:43Z

ports/raspberrypi/boards/fwk_keyboard/mpconfigboard.mk

@@ -0,0 +1,64 @@
+USB_VID = 0x32AC
+USB_PID = 0x0013


TODO: I think I want to rename the board and use a different PID.

Changed to draft.

Signed-off-by: Daniel Schaefer <dhs@frame.work>

JohnAZoidberg · 2023-08-09T09:38:16Z

ports/raspberrypi/supervisor/internal_flash.c

@@ -99,11 +99,15 @@ void port_internal_flash_flush(void) {
    // Make sure we don't have an interrupt while we do flash operations.
    common_hal_mcu_disable_interrupts();
    // and audio DMA must be paused as well
+    #if CIRCUITPY_AUDIOCORE


Made a separate PR for this: #8271

jepler · 2023-08-09T12:56:46Z

I don't know how durable your "serial number in flash" concept will be, but it doesn't mean it's not worth trying. For instance, we advise folks that in extreme circumstances they can run a program that erases all flash content: https://learn.adafruit.com/adafruit-feather-rp2040-pico/circuitpython#flash-resetting-uf2-3091244 (this is nuke.c from pico-examples, I think)

at a guess you'll at least need to revise these two in raspberrypi/supervisor/internal_flash.c

Probably fix by defining TOTAL_FLASH_MINIMUM as 1024*1024-4096 in mpconfigboard.mk:

#if !defined(TOTAL_FLASH_MINIMUM)
#define TOTAL_FLASH_MINIMUM (2 * 1024 * 1024)
#endif

Probably fix by introducing a new constant, defined to 0 in mpconfigport.h if not otherwise defined, and defined to 4096 in your board, and subtracting it from _flash_size:

uint32_t supervisor_flash_get_block_count(void) {
    return (_flash_size - CIRCUITPY_CIRCUITPY_DRIVE_START_ADDR) / FILESYSTEM_BLOCK_SIZE;
}

dhalbert · 2023-08-09T13:04:59Z

The RP2040, as you know, doesn't have a unique serial number. However, some or all of the external flash chips do:
https://stackoverflow.com/questions/72594333/arduino-rp2040-pico-unique-id
https://forums.raspberrypi.com/viewtopic.php?t=331910
etc.

So you can use that instead, and other people have done so. And it won't be erased by the nuke UF2. (And you won't need the extra settings above.)

dhalbert · 2023-08-09T13:08:38Z

CircuitPython can access the flash UID by microcontroller.cpu.uid: https://docs.circuitpython.org/en/latest/shared-bindings/microcontroller/index.html#microcontroller.Processor.uid

The code we use to fetch it is here:

circuitpython/ports/raspberrypi/common-hal/microcontroller/Processor.c

Lines 88 to 92 in 7432bbc

    
           void common_hal_mcu_processor_get_uid(uint8_t raw_id[]) { 
        
               pico_unique_board_id_t retrieved_id; 
        
               pico_get_unique_board_id(&retrieved_id); 
        
               memcpy(raw_id, retrieved_id.id, COMMON_HAL_MCU_PROCESSOR_UID_LENGTH); 
        
           }

:

dhalbert · 2024-07-02T20:04:53Z

@JohnAZoidberg Hi - is this project still in process?

stealthcopter · 2024-10-24T07:46:07Z

ports/raspberrypi/boards/framework_inputmodule/pins.c

+    { MP_ROM_QSTR(MP_QSTR_SDA), MP_ROM_PTR(&pin_GPIO26) },
+    { MP_ROM_QSTR(MP_QSTR_SCL), MP_ROM_PTR(&pin_GPIO27) },
+
+    { MP_ROM_QSTR(MP_QSTR_I2C), MP_ROM_PTR(&board_i2c_obj) },


Suggested change

{ MP_ROM_QSTR(MP_QSTR_I2C), MP_ROM_PTR(&board_i2c_obj) },

{ MP_ROM_QSTR(MP_QSTR_I2C), MP_ROM_PTR(&board_i2c_obj) },

// Add GP6 and GP7

{ MP_ROM_QSTR(MP_QSTR_GP6), MP_ROM_PTR(&pin_GPIO6) },

{ MP_ROM_QSTR(MP_QSTR_GP7), MP_ROM_PTR(&pin_GPIO7) },

// KSO Pins (Key Scan Output)

{ MP_ROM_QSTR(MP_QSTR_KSO0), MP_ROM_PTR(&pin_GPIO8) },

{ MP_ROM_QSTR(MP_QSTR_KSO1), MP_ROM_PTR(&pin_GPIO9) },

{ MP_ROM_QSTR(MP_QSTR_KSO2), MP_ROM_PTR(&pin_GPIO10) },

{ MP_ROM_QSTR(MP_QSTR_KSO3), MP_ROM_PTR(&pin_GPIO11) },

{ MP_ROM_QSTR(MP_QSTR_KSO4), MP_ROM_PTR(&pin_GPIO12) },

{ MP_ROM_QSTR(MP_QSTR_KSO5), MP_ROM_PTR(&pin_GPIO13) },

{ MP_ROM_QSTR(MP_QSTR_KSO6), MP_ROM_PTR(&pin_GPIO14) },

{ MP_ROM_QSTR(MP_QSTR_KSO7), MP_ROM_PTR(&pin_GPIO15) },

// Additional KSO pins

{ MP_ROM_QSTR(MP_QSTR_KSO8), MP_ROM_PTR(&pin_GPIO21) },

{ MP_ROM_QSTR(MP_QSTR_KSO9), MP_ROM_PTR(&pin_GPIO20) },

{ MP_ROM_QSTR(MP_QSTR_KSO10), MP_ROM_PTR(&pin_GPIO19) },

{ MP_ROM_QSTR(MP_QSTR_KSO11), MP_ROM_PTR(&pin_GPIO18) },

{ MP_ROM_QSTR(MP_QSTR_KSO12), MP_ROM_PTR(&pin_GPIO17) },

{ MP_ROM_QSTR(MP_QSTR_KSO13), MP_ROM_PTR(&pin_GPIO16) },

{ MP_ROM_QSTR(MP_QSTR_KSO14), MP_ROM_PTR(&pin_GPIO23) },

{ MP_ROM_QSTR(MP_QSTR_KSO15), MP_ROM_PTR(&pin_GPIO22) },

// MUX pins (Multiplexer control)

{ MP_ROM_QSTR(MP_QSTR_MUX_ENABLE), MP_ROM_PTR(&pin_GPIO4) },

{ MP_ROM_QSTR(MP_QSTR_MUX_A), MP_ROM_PTR(&pin_GPIO1) },

{ MP_ROM_QSTR(MP_QSTR_MUX_B), MP_ROM_PTR(&pin_GPIO2) },

{ MP_ROM_QSTR(MP_QSTR_MUX_C), MP_ROM_PTR(&pin_GPIO3) },

{ MP_ROM_QSTR(MP_QSTR_BOOT_DONE), MP_ROM_PTR(&pin_GPIO5) },

Adding in the missing changes I believe are necessary to get the board working from FrameworkComputer/Framework_Inputmodule_CircuitPython#2 (comment)

JohnAZoidberg commented Jul 29, 2023

View reviewed changes

ports/raspberrypi/fwk_keyboard/mpconfigboard.mk Outdated Show resolved Hide resolved

dhalbert requested changes Jul 29, 2023

View reviewed changes

fwk_keyboard: Add new rp2040 based board

1c5fa3c

Signed-off-by: Daniel Schaefer <dhs@frame.work>

JohnAZoidberg force-pushed the fwk_keyboard branch from 68b725b to 1c5fa3c Compare July 29, 2023 15:55

JohnAZoidberg added 2 commits August 2, 2023 12:06

raspberrypi: Allow build without audio

6f4d131

Signed-off-by: Daniel Schaefer <dhs@frame.work>

boards/fwk_keyboard: Reduce firmware size to below 500KB

74e9ee1

Memory region Used Size Region Size %age Used FLASH_FIRMWARE: 472304 B 512 KB 90.08% RAM: 45952 B 256 KB 17.53% SCRATCH_Y: 0 GB 4 KB 0.00% SCRATCH_X: 2 KB 4 KB 50.00% Signed-off-by: Daniel Schaefer <dhs@frame.work>

JohnAZoidberg commented Aug 2, 2023

View reviewed changes

dhalbert marked this pull request as draft August 2, 2023 12:19

JohnAZoidberg added 3 commits August 9, 2023 17:20

fixup! boards/fwk_keyboard: Reduce firmware size to below 500KB

0d3541d

boards/fwk_keyboard: Generic PID and name

4ef3c7b

Signed-off-by: Daniel Schaefer <dhs@frame.work>

boards/framework_inputmodule: Rename to generic name

60bd613

Signed-off-by: Daniel Schaefer <dhs@frame.work>

JohnAZoidberg changed the title ~~fwk_keyboard: Add new rp2040 based board~~ framework_inputmodule: Add new rp2040 based board Aug 9, 2023

JohnAZoidberg added 3 commits August 9, 2023 17:31

fixup! raspberrypi: Allow build without audio

a6c653e

fixup! boards/fwk_keyboard: Reduce firmware size to below 500KB

0250c58

fixup! boards/fwk_keyboard: Reduce firmware size to below 500KB

029c7a0

JohnAZoidberg commented Aug 9, 2023

View reviewed changes

jepler added the board New board or update to a single board label Aug 22, 2023

tannewt mentioned this pull request Oct 23, 2024

Error running macropad_keyscan.py, possible missing pin definitions in pins.c? FrameworkComputer/Framework_Inputmodule_CircuitPython#2

Open

stealthcopter reviewed Oct 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

framework_inputmodule: Add new rp2040 based board #8233

framework_inputmodule: Add new rp2040 based board #8233

JohnAZoidberg commented Jul 29, 2023 •

edited

Loading

dhalbert Jul 29, 2023

dhalbert Jul 29, 2023

JohnAZoidberg Jul 29, 2023

dhalbert Jul 29, 2023

jepler Jul 31, 2023

JohnAZoidberg Aug 1, 2023

JohnAZoidberg Aug 2, 2023

JohnAZoidberg Aug 9, 2023

tannewt Aug 9, 2023

JohnAZoidberg Aug 2, 2023

dhalbert Aug 2, 2023

JohnAZoidberg Aug 9, 2023

jepler commented Aug 9, 2023 •

edited

Loading

dhalbert commented Aug 9, 2023

dhalbert commented Aug 9, 2023 •

edited

Loading

dhalbert commented Jul 2, 2024

stealthcopter Oct 24, 2024

-    { MP_ROM_QSTR(MP_QSTR_I2C), MP_ROM_PTR(&board_i2c_obj) },
+    { MP_ROM_QSTR(MP_QSTR_I2C), MP_ROM_PTR(&board_i2c_obj) },
+    // Add GP6 and GP7
+    { MP_ROM_QSTR(MP_QSTR_GP6), MP_ROM_PTR(&pin_GPIO6) },
+    { MP_ROM_QSTR(MP_QSTR_GP7), MP_ROM_PTR(&pin_GPIO7) },
+    // KSO Pins (Key Scan Output)
+    { MP_ROM_QSTR(MP_QSTR_KSO0), MP_ROM_PTR(&pin_GPIO8) },
+    { MP_ROM_QSTR(MP_QSTR_KSO1), MP_ROM_PTR(&pin_GPIO9) },
+    { MP_ROM_QSTR(MP_QSTR_KSO2), MP_ROM_PTR(&pin_GPIO10) },
+    { MP_ROM_QSTR(MP_QSTR_KSO3), MP_ROM_PTR(&pin_GPIO11) },
+    { MP_ROM_QSTR(MP_QSTR_KSO4), MP_ROM_PTR(&pin_GPIO12) },
+    { MP_ROM_QSTR(MP_QSTR_KSO5), MP_ROM_PTR(&pin_GPIO13) },
+    { MP_ROM_QSTR(MP_QSTR_KSO6), MP_ROM_PTR(&pin_GPIO14) },
+    { MP_ROM_QSTR(MP_QSTR_KSO7), MP_ROM_PTR(&pin_GPIO15) },
+    // Additional KSO pins
+    { MP_ROM_QSTR(MP_QSTR_KSO8), MP_ROM_PTR(&pin_GPIO21) },
+    { MP_ROM_QSTR(MP_QSTR_KSO9), MP_ROM_PTR(&pin_GPIO20) },
+    { MP_ROM_QSTR(MP_QSTR_KSO10), MP_ROM_PTR(&pin_GPIO19) },
+    { MP_ROM_QSTR(MP_QSTR_KSO11), MP_ROM_PTR(&pin_GPIO18) },
+    { MP_ROM_QSTR(MP_QSTR_KSO12), MP_ROM_PTR(&pin_GPIO17) },
+    { MP_ROM_QSTR(MP_QSTR_KSO13), MP_ROM_PTR(&pin_GPIO16) },
+    { MP_ROM_QSTR(MP_QSTR_KSO14), MP_ROM_PTR(&pin_GPIO23) },
+    { MP_ROM_QSTR(MP_QSTR_KSO15), MP_ROM_PTR(&pin_GPIO22) },
+    // MUX pins (Multiplexer control)
+    { MP_ROM_QSTR(MP_QSTR_MUX_ENABLE), MP_ROM_PTR(&pin_GPIO4) },
+    { MP_ROM_QSTR(MP_QSTR_MUX_A), MP_ROM_PTR(&pin_GPIO1) },
+    { MP_ROM_QSTR(MP_QSTR_MUX_B), MP_ROM_PTR(&pin_GPIO2) },
+    { MP_ROM_QSTR(MP_QSTR_MUX_C), MP_ROM_PTR(&pin_GPIO3) },
+    { MP_ROM_QSTR(MP_QSTR_BOOT_DONE), MP_ROM_PTR(&pin_GPIO5) },

framework_inputmodule: Add new rp2040 based board #8233

Are you sure you want to change the base?

framework_inputmodule: Add new rp2040 based board #8233

Conversation

JohnAZoidberg commented Jul 29, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jepler commented Aug 9, 2023 • edited Loading

dhalbert commented Aug 9, 2023

dhalbert commented Aug 9, 2023 • edited Loading

dhalbert commented Jul 2, 2024

Choose a reason for hiding this comment

JohnAZoidberg commented Jul 29, 2023 •

edited

Loading

jepler commented Aug 9, 2023 •

edited

Loading

dhalbert commented Aug 9, 2023 •

edited

Loading