Add support for Raspberry Pi Pico 2, Pico 2 W

hardware/EuroPi/bill_of_materials.md

@@ -37,7 +37,7 @@ If buying in bulk there are likely other suppliers that are cheaper - this BOM i
 | | 2 | T18 Shaft | Knobs | [Thonk](https://www.thonk.co.uk/shop/1900h-t18/)<br>**NOTE: If you buy D-Shaft potentiometers, the knobs must be 'Reverse-D-Shaft' type.<br>Any knobs which fit may be chosen, but Mouser does not stock the standard suggestion sold by Thonk**
 | | 1 | 10 - 16 Pin | Eurorack Power Cable | [Thonk](https://www.thonk.co.uk/shop/eurorack-power-cables/)<br>**Note: Mouser does not stock the correct cable at time of writing. Other suppliers will provide the correct part, but always double check that the polarity is correct (red stripe is always -12V)**
 | | 1 | | Micro USB Cable (Capable of Data Transfer) | [CPC](https://cpc.farnell.com/pro-signal/psg91562/lead-usb-a-male-micro-b-male-black/dp/CS32732), [The Pi Hut](https://thepihut.com/products/usb-to-micro-usb-cable-0-5m)<br>[Mouser](https://www.mouser.co.uk/ProductDetail/Teltonika/PR2US08M?qs=9vOqFld9vZXl90mLcdqZXQ%3D%3D)
-| | 1 | | Raspberry Pi Pico | [The Pi Hut](https://thepihut.com/products/raspberry-pi-pico)<br>[CPC](https://cpc.farnell.com/raspberry-pi/raspberry-pi-pico/raspberry-pi-pico-rp2040-mcu-board/dp/SC17106)<br>[Mouser](https://www.mouser.co.uk/ProductDetail/Raspberry-Pi/SC0915?qs=T%252BzbugeAwjgnLi4azxXVFA%3D%3D)<br>**Note: Any official version of the Raspberry Pi Pico will work (W, H, or WH). Third party RP2040 boards may work, but there is no guarantee - always double check the pinout**
+| | 1 | | Raspberry Pi Pico | [The Pi Hut](https://thepihut.com/products/raspberry-pi-pico)<br>[CPC](https://cpc.farnell.com/raspberry-pi/raspberry-pi-pico/raspberry-pi-pico-rp2040-mcu-board/dp/SC17106)<br>[Mouser](https://www.mouser.co.uk/ProductDetail/Raspberry-Pi/SC0915?qs=T%252BzbugeAwjgnLi4azxXVFA%3D%3D)<br>The Raspberry Pi Pico 2 is also usable [with additional configuration](/software/CONFIGURATION.md)<br>**Note: Any official version of the Raspberry Pi Pico will work (W, H, or WH). Third party RP2040 or RP2350 boards may work, but there is no guarantee - always double check the pinout. RP2350 boards should be [configured like the Pico 2](/software/CONFIGURATION.md)**
 
 #### Note about OLED
 The OLED has two suppliers listed, each with different pin configurations. The module supports either of these two configurations (the most common), but no others, so make sure that the one you buy, wherever you source it, has one of these two configurations.

software/CONFIGURATION.md

@@ -8,7 +8,7 @@ default configuration:
 {
     "EUROPI_MODEL": "europi",
     "PICO_MODEL": "pico",
-    "CPU_FREQ": 250000000,
+    "CPU_FREQ": "overclocked",
     "ROTATE_DISPLAY": false,
     "DISPLAY_WIDTH": 128,
     "DISPLAY_HEIGHT": 32,
@@ -29,8 +29,15 @@ default configuration:
 
 CPU & Pico options:
 - `EUROPI_MODEL` specifies the type of EuroPi module. Currently only `"europi"` is supported. Default: `"europi"`
-- `PICO_MODEL` must be one of `"pico"` or `"pico w"`. Default: `"pico"`
-- `CPU_FREQ` must be one of `250000000` or `125000000`. Default: `"250000000"`
+- `PICO_MODEL` must be one of
+  - `"pico"`,
+  - `"pico h"`,
+  - `"pico w"`,
+  - `"pico 2"`, or
+  - `"pico 2w"`.
+  Default: `"pico"`.
+- `CPU_FREQ` specifies whether or not the CPU should be overclocked. Must be one of `"overclocked"` or `"normal"`.
+  Default: `"overclocked"`
 
 Display options:
 - `ROTATE_DISPLAY` must be one of `false` or `true`. Default: `false`
@@ -59,6 +66,9 @@ Power options:
 - `MENU_AFTER_POWER_ON` is a boolean indicating whether or not the module should always return to the main menu when
   it powers on.  By default the EuroPi will re-launch the last-used program instead of returning to the main menu. Default: `false`
 
+If you assembled your module with the Raspberry Pi Pico 2 (or a clone featuring the RP2350 microcontroller) make sure to
+set the `PICO_MODEL` setting to `"pico2"`.
+
 
 # Experimental configuration
 

software/contrib/diagnostic.py

@@ -17,6 +17,8 @@
     k1,
     k2,
     oled,
+    europi_config,
+    thermometer,
 )
 from europi_script import EuroPiScript
 import configuration
@@ -40,7 +42,6 @@
 class Diagnostic(EuroPiScript):
     def __init__(self):
         super().__init__()
-        self.temp_sensor = ADC(4)
         self.voltages = [
             0,  # min
             0.5,  # not 0 but still below DI's threshold
@@ -58,7 +59,7 @@ def config_points(cls):
 
     def calc_temp(self):
         # see the pico's datasheet for the details of this calculation
-        t = 27 - ((self.temp_sensor.read_u16() * TEMP_CONV_FACTOR) - 0.706) / 0.001721
+        t = thermometer.read_temperature()
         if self.use_fahrenheit:
             t = (t * 1.8) + 32
         return t

software/contrib/lutra.py

@@ -269,7 +269,12 @@ def gui_render_thread(self):
         """A thread function that handles drawing the GUI
         """
         SHOW_WAVE_TIMEOUT = 3000
-        while True:
+
+        # To prevent the module locking up when we connect the USB for e.g. debugging, kill this thread
+        # if the USB state changes. Otherwise the second core will continue being busy, which makes connecting
+        # to the Python terminal impossible
+        usb_connected_at_start = usb_connected.value()
+        while usb_connected.value() == usb_connected_at_start:
             now = time.ticks_ms()
             oled.fill(0)
             with self.pixel_lock:
@@ -283,11 +288,9 @@ def gui_render_thread(self):
     def wave_generation_thread(self):
         """A thread function that handles the underlying math of generating the waveforms
         """
-        usb_connected_at_start = usb_connected.value()
-
         # To prevent the module locking up when we connect the USB for e.g. debugging, kill this thread
-        # if the USB state changes. Otherwise the second core will continue being busy, which makes connecting
-        # to the Python terminal impossible
+        # if the USB state changes
+        usb_connected_at_start = usb_connected.value()
         while usb_connected.value() == usb_connected_at_start:
             # Read the digital inputs
             self.digital_input_state.update()

software/firmware/calibrate.py

@@ -1,6 +1,5 @@
-from machine import Pin, ADC, PWM, freq
 from time import sleep
-from europi import oled, b1, b2, PIN_USB_CONNECTED, PIN_CV1, PIN_AIN
+from europi import oled, b1, b2, ain, cv1, usb_connected
 from europi_script import EuroPiScript
 from os import stat, mkdir
 
@@ -12,14 +11,10 @@ def display_name(cls):
         return "~Calibrate"
 
     def main(self):
-        ain = ADC(Pin(PIN_AIN, Pin.IN, Pin.PULL_DOWN))
-        cv1 = PWM(Pin(PIN_CV1))
-        usb = Pin(PIN_USB_CONNECTED, Pin.IN)
-
         def sample():
             readings = []
             for reading in range(256):
-                readings.append(ain.read_u16())
+                readings.append(ain.pin.read_u16())
             return round(sum(readings) / 256)
 
         def wait_for_voltage(voltage):
@@ -38,17 +33,6 @@ def text_wait(text, wait):
             oled.centre_text(text)
             sleep(wait)
 
-        def fill_show(colour):
-            oled.fill(colour)
-            oled.show()
-
-        def flash(flashes, period):
-            for flash in range(flashes):
-                fill_show(1)
-                sleep(period / 2)
-                fill_show(0)
-                sleep(period / 2)
-
         def wait_for_b1(value):
             while b1.value() != value:
                 sleep(0.05)
@@ -62,7 +46,7 @@ def wait_for_b1(value):
 
         # Calibration start
 
-        if usb.value() == 1:
+        if usb_connected.value() == 1:
             oled.centre_text("Make sure rack\npower is on\nDone: Button 1")
             wait_for_b1(1)
             wait_for_b1(0)
@@ -109,11 +93,11 @@ def wait_for_b1(value):
 
         output_duties = [0]
         duty = 0
-        cv1.duty_u16(duty)
+        cv1.pin.duty_u16(duty)
         reading = sample()
         for index, expected_reading in enumerate(readings[1:]):
             while abs(reading - expected_reading) > 0.002 and reading < expected_reading:
-                cv1.duty_u16(duty)
+                cv1.pin.duty_u16(duty)
                 duty += 10
                 reading = sample()
             output_duties.append(duty)

software/firmware/europi.py

@@ -23,15 +23,15 @@
 from machine import PWM
 from machine import Pin
 from machine import freq
-
+from machine import mem32
 
 from ssd1306 import SSD1306_I2C
 
 from version import __version__
 
 from configuration import ConfigSettings
 from framebuf import FrameBuffer, MONO_HLSB
-from europi_config import load_europi_config
+from europi_config import load_europi_config, CPU_FREQS
 from experimental.experimental_config import load_experimental_config
 
 if sys.implementation.name == "micropython":
@@ -107,7 +107,7 @@
 PIN_CV4 = 17
 PIN_CV5 = 18
 PIN_CV6 = 19
-PIN_USB_CONNECTED = 24
+PIN_USB_CONNECTED = 24  # Does not work on Pico 2
 
 # Helper functions.
 
@@ -622,6 +622,64 @@ def value(self, value):
             self.off()
 
 
+class Thermometer:
+    """
+    Wrapper for the temperature sensor connected to Pin 4
+    Reports the module's current temperature in Celsius.
+    If the module's temperature sensor is not working correctly, the temperature will always be reported as None
+    """
+
+    # Conversion factor for converting from the raw ADC reading to sensible units
+    # See Raspberry Pi Pico datasheet for details
+    TEMP_CONV_FACTOR = 3.3 / 65535
+
+    def __init__(self):
+        # The Raspberry Pi Pico 2's temperature sensor doesn't work with some older
+        # uPython firmwares so do some basic exception handling
+        try:
+            self.pin = ADC(PIN_TEMPERATURE)
+        except:
+            self.pin = None
+
+    def read_temperature(self):
+        """
+        Read the ADC and return the current temperature
+        @return  The current temperature in Celsius, or None if the hardware did not initialze properly
+        """
+        if self.pin:
+            # See the Pico's datasheet for the details of this calculation
+            return 27 - ((self.pin.read_u16() * self.TEMP_CONV_FACTOR) - 0.706) / 0.001721
+        else:
+            return None
+
+
+class UsbConnection:
+    """
+    Checks the USB terminal is connected or not
+    On the original Pico we can check Pin 24, but on the Pico 2 this does not work. In that case
+    check the SIE_STATUS register and check bit 16
+    """
+
+    def __init__(self):
+        if europi_config.PICO_MODEL == "pico2":
+            self.pin = None
+        else:
+            self.pin = DigitalReader(PIN_USB_CONNECTED)
+
+    def value(self):
+        """Return 0 or 1, indicating if the USB connection is disconnected or connected"""
+        if self.pin:
+            return self.pin.value()
+        else:
+            # see https://forum.micropython.org/viewtopic.php?t=10814#p59545
+            SIE_STATUS = 0x50110000 + 0x50
+            BIT_CONNECTED = 1 << 16
+            if mem32[SIE_STATUS] & BIT_CONNECTED:
+                return 1
+            else:
+                return 0
+
+
 # Define all the I/O using the appropriate class and with the pins used
 din = DigitalInput(PIN_DIN)
 ain = AnalogueInput(PIN_AIN)
@@ -639,6 +697,12 @@ def value(self, value):
 cv6 = Output(PIN_CV6)
 cvs = [cv1, cv2, cv3, cv4, cv5, cv6]
 
+# Helper object to detect if the USB cable is connected or not
+usb_connected = UsbConnection()
+
+# Helper object for reading the onboard temperature sensor
+thermometer = Thermometer()
+
 # External I2C
 external_i2c = I2C(
     europi_config.EXTERNAL_I2C_CHANNEL,
@@ -648,10 +712,10 @@ def value(self, value):
     timeout=europi_config.EXTERNAL_I2C_TIMEOUT,
 )
 
-usb_connected = DigitalReader(PIN_USB_CONNECTED, 0)
-
-# Overclock the Pico for improved performance.
-freq(europi_config.CPU_FREQ)
+# Set the desired clock speed according to the configuration
+# By default this will overclock the CPU, but some users may not want to
+# e.g. to lower power consumption on a very power-constrained system
+freq(CPU_FREQS[europi_config.PICO_MODEL][europi_config.CPU_FREQ])
 
 # Reset the module state upon import.
 reset_state()