esp: make cpu frequency settable

Author: Sola85

locale/circuitpython.pot

@@ -1029,11 +1029,27 @@ msgstr ""
 msgid "Format not supported"
 msgstr ""
 
+#: ports/espressif/common-hal/microcontroller/Processor.c
+msgid "Frequency must be 20, 40, 80 or 120MHz"
+msgstr ""
+
+#: ports/espressif/common-hal/microcontroller/Processor.c
+msgid "Frequency must be 20, 40, 80 or 160MHz"
+msgstr ""
+
+#: ports/espressif/common-hal/microcontroller/Processor.c
+msgid "Frequency must be 20, 40, 80, 160 or 240MHz"
+msgstr ""
+
 #: ports/mimxrt10xx/common-hal/microcontroller/Processor.c
 msgid ""
 "Frequency must be 24, 150, 396, 450, 528, 600, 720, 816, 912, 960 or 1008 Mhz"
 msgstr ""
 
+#: ports/espressif/common-hal/microcontroller/Processor.c
+msgid "Frequency must be 32, 48, 64 or 96MHz"
+msgstr ""
+
 #: shared-bindings/bitbangio/I2C.c shared-bindings/bitbangio/SPI.c
 #: shared-bindings/busio/I2C.c shared-bindings/busio/SPI.c
 msgid "Function requires lock"

ports/espressif/common-hal/microcontroller/Processor.c

@@ -10,12 +10,14 @@
 
 #include "py/runtime.h"
 
+#include "bindings/espidf/__init__.h"
 #include "common-hal/microcontroller/Processor.h"
 #include "shared-bindings/microcontroller/Processor.h"
 #include "shared-bindings/microcontroller/ResetReason.h"
 
 #include "esp_sleep.h"
 #include "esp_system.h"
+#include "esp_pm.h"
 
 #include "soc/efuse_reg.h"
 
@@ -44,9 +46,51 @@ float common_hal_mcu_processor_get_voltage(void) {
 }
 
 uint32_t common_hal_mcu_processor_get_frequency(void) {
-    return CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ * 1000000;
+    esp_pm_config_t pm;
+    CHECK_ESP_RESULT(esp_pm_get_configuration(&pm));
+    return pm.min_freq_mhz * 1000000;
 }
 
+#if defined(CIRCUITPY_SETTABLE_PROCESSOR_FREQUENCY) // Don't need a NotImplementedError here if this is false, as that is handled in shared-bindings
+static void validate_cpu_frequency(uint32_t freq_mhz) {
+    #if defined(CONFIG_IDF_TARGET_ESP32C3) || defined(CONFIG_IDF_TARGET_ESP32C6)
+    if (freq_mhz != 20 && freq_mhz != 40 && freq_mhz != 80 && freq_mhz != 160) {
+        mp_raise_ValueError(MP_ERROR_TEXT("Frequency must be 20, 40, 80 or 160MHz"));
+    }
+    #elif defined(CONFIG_IDF_TARGET_ESP32C2)
+    if (freq_mhz != 20 && freq_mhz != 40 && freq_mhz != 80 && freq_mhz != 120) {
+        mp_raise_ValueError(MP_ERROR_TEXT("Frequency must be 20, 40, 80 or 120MHz"));
+    }
+    #elif defined(CONFIG_IDF_TARGET_ESP32H2)
+    if (freq_mhz != 32 && freq_mhz != 48 && freq_mhz != 64 && freq_mhz != 96) {
+        mp_raise_ValueError(MP_ERROR_TEXT("Frequency must be 32, 48, 64 or 96MHz"));
+    }
+    #else
+    if (freq_mhz != 20 && freq_mhz != 40 && freq_mhz != 80 && freq_mhz != 160 && freq_mhz != 240) {
+        mp_raise_ValueError(MP_ERROR_TEXT("Frequency must be 20, 40, 80, 160 or 240MHz"));
+    }
+    #endif
+}
+
+void common_hal_mcu_processor_set_frequency(mcu_processor_obj_t *self, uint32_t frequency) {
+    // Without this check, everything would compile without error, but silently fail at runtime if
+    // CONFIG_PM_ENABLE is ever accidentally disabled
+    #if !defined(CONFIG_PM_ENABLE)
+    #error "common_hal_mcu_processor_set_frequency needs CONFIG_PM_ENABLE to be defined."
+    #endif
+
+    frequency /= 1000000;
+
+    validate_cpu_frequency(frequency);
+
+    esp_pm_config_t pm;
+    pm.max_freq_mhz = frequency;
+    pm.min_freq_mhz = frequency;
+    pm.light_sleep_enable = false;
+    CHECK_ESP_RESULT(esp_pm_configure(&pm));
+}
+#endif
+
 static uint8_t swap_nibbles(uint8_t v) {
     return ((v << 4) | (v >> 4)) & 0xff;
 }

ports/espressif/esp-idf-config/sdkconfig.defaults

@@ -34,6 +34,8 @@ CONFIG_GPTIMER_ISR_IRAM_SAFE=y
 CONFIG_ESP_MAIN_TASK_STACK_SIZE=16384
 # CONFIG_ESP_TASK_WDT_INIT is not set
 # CONFIG_ESP_DEBUG_OCDAWARE is not set
+
+CONFIG_PM_ENABLE=y  # required for CIRCUITPY_SETTABLE_PROCESSOR_FREQUENCY
 # end of ESP System Settings
 
 

ports/espressif/mpconfigport.mk

@@ -228,3 +228,5 @@ CIRCUITPY_MESSAGE_COMPRESSION_LEVEL ?= 1
 
 CIRCUITPY_AUDIOMP3 ?= 1
 CIRCUITPY_AUDIOMP3_USE_PORT_ALLOCATOR ?= 1
+
+CIRCUITPY_SETTABLE_PROCESSOR_FREQUENCY ?= 1