ESP-IDFを使ってみる

PSRAM

ESP32のSoCにはSRAMが内蔵されていますが、520KBしかありません。
PSRAMが利用可能な開発ボードでは、PSRAMを疑似SRAMとして使う事ができます。

ESP32のSoCには以下のバリエーションが有ります。
① FlashもPSRAMも内蔵されていない
② Flashだけが内蔵されている
③ PSRAMだけが内蔵されている
④ FlashもPSRAMも内蔵されている
PSRAMは揮発性なので、コードを保持するためにはFlashが必須となります。
Flashが内蔵されていないSoCでは、必ず外部Flashを使います。

疑似SRAMと純粋なSRAMとの違いはこちらに公開されています。
また、ESP-IDFにおけるPSRAMのサポートについてはこちらに公開されています。
PSRAMのサイズを調べるAPIにesp_psram_get_size()が有りますが、設定がちょっとトリッキーです。

まず、menuconfigを使ってSupport for external, SPI-connected RAMを有効にします。

これだけだと、PSRAMを持っていないESP32ではesp_psram_get_size()がHALTしてしまいます。
そこで、さらにIgnore PSRAM when not foundを有効にします。
この設定は、esp-idfのgithub issuesに書き込んでようやく分かりました。

これで、どのようなSoCでも、以下のコードでPSRAMの有無とサイズを判定できるようになります。

#include <stdio.h>

              #include <inttypes.h>

              #include "freertos/FreeRTOS.h"

              #include "freertos/task.h"

              #include "esp_err.h"

              #include "esp_log.h"

              #include "esp_chip_info.h"

              #include "esp_flash.h"

              #if CONFIG_SPIRAM

              #include "esp_psram.h"

              #endif

              

              static const char *TAG = "MAIN";

              

              int spi_flash_size() {

                      uint32_t
              chip_id;

                     
              ESP_ERROR_CHECK(esp_flash_read_id(NULL, &chip_id));

                      ESP_LOGI(TAG,
              "chip ID=0x%"PRIx32, chip_id);

                      int
              flash_capacity = chip_id & 0xff;

                      ESP_LOGI(TAG,
              "flash_capacity=0x%x", flash_capacity);

                      int
              real_flash_size = 0;

                      if
              (flash_capacity == 0x15) {

                             

              real_flash_size = 2;

                      } else if
              (flash_capacity == 0x16) {

                             

              real_flash_size = 4;

                      } else if
              (flash_capacity == 0x17) {

                             

              real_flash_size = 8;

                      } else if
              (flash_capacity == 0x18) {

                             

              real_flash_size = 16;

                      }

                      ESP_LOGD(TAG,
              "real_flash_siz=%d", real_flash_size);

                      return
              real_flash_size;

              }

              

              void app_main()

              {

                      esp_chip_info_t
              chip_info;

                     
              esp_chip_info(&chip_info);

                      // Print out
              embedded or external

                      uint32_t
              embedded = chip_info.features &
              CHIP_FEATURE_EMB_FLASH;

                      ESP_LOGI(TAG,
              "embedded=%"PRIx32, embedded);

                      if (embedded) {

                             

              ESP_LOGI(TAG, "embedded flash");

                             

              uint32_t flash_size;

                             

              ESP_ERROR_CHECK(esp_flash_get_size(NULL,
              &flash_size));

                             

              size_t flash_size_k =  flash_size / 1024;

                             

              size_t flash_size_m =  flash_size_k / 1024;

                             

              ESP_LOGI(TAG, "embedded %d MBytes flash", flash_size_m);

                      } else {

                             

              ESP_LOGI(TAG, "external flash");

                             

              int flash_size = spi_flash_size();

                             

              ESP_LOGI(TAG, "external %d Mbytes flash", flash_size);

                      }

              

              #if CONFIG_SPIRAM

                      size_t
              psram_size = esp_psram_get_size();

                      size_t
              psram_size_k = psram_size/1024;

                      size_t
              psram_size_m = psram_size_k/1024;

                      ESP_LOGI(TAG,
              "PSRAM size: %d bytes %d Mbytes", psram_size,
              psram_size_m);

              #endif

              

                      ESP_LOGI(TAG,
              "MALLOC_CAP_INTERNAL: %d bytes",
              heap_caps_get_free_size(MALLOC_CAP_INTERNAL));

                      ESP_LOGI(TAG,
              "MALLOC_CAP_SPIRAM: %d bytes",
              heap_caps_get_free_size(MALLOC_CAP_SPIRAM));

                      ESP_LOGI(TAG,
              "Free heap size: %"PRIu32" bytes",
              esp_get_free_heap_size());

                      ESP_LOGI(TAG,
              "Free heap size: %"PRIu32" K bytes",
              esp_get_free_heap_size()/1024);

                      //ESP_LOGI(TAG,
              "Free heap size (caps): %u",
              heap_caps_get_free_size(MALLOC_CAP_8BIT));

              }

PSRAMを持っていないESP32ではesp_psram_get_size()から0が戻ります。
また、MALLOC_CAP_SPIRAMのサイズも0になります。
使用できるHEAPのサイズも300Kぐらいです。

I (326) main_task: Started on CPU0

              I (336) main_task: Calling app_main()

              I (336) MAIN: embedded=0

              I (336) MAIN: external flash

              I (336) MAIN: chip ID=0x204016

              I (336) MAIN: flash_capacity=0x16

              I (336) MAIN: external 4 Mbytes flash

              I (346) MAIN: PSRAM size: 0 bytes 0 Mbytes

              I (346) MAIN: MALLOC_CAP_INTERNAL: 367524 bytes

              I (346) MAIN: MALLOC_CAP_SPIRAM: 0 bytes

              I (356) MAIN: Free heap size: 303616 bytes

              I (356) MAIN: Free heap size: 296 K bytes

ESP-CAMなどのPSRAMを持っているESP32ではesp_psram_get_size()でPSRAMのサイズを知ることができます。
また、MALLOC_CAP_SPIRAMのサイズも0以外になります。
使用できるHEAPのサイズも4400Kとメチャクチャ大きくなります。

I (1218) main_task: Started on CPU0

              I (1228) esp_psram: Reserving pool of 32K of internal
              memory for DMA/internal allocations

              I (1228) main_task: Calling app_main()

              I (1228) MAIN: embedded=0

              I (1228) MAIN: external flash

              I (1228) MAIN: chip ID=0x5e4016

              I (1238) MAIN: flash_capacity=0x16

              I (1238) MAIN: external 4 Mbytes flash

              I (1238) MAIN: PSRAM size: 8388608 bytes 8 Mbytes

              I (1248) MAIN: MALLOC_CAP_INTERNAL: 366815 bytes

              I (1248) MAIN: MALLOC_CAP_SPIRAM: 4192024 bytes

              I (1258) MAIN: Free heap size: 4462900 bytes

              I (1258) MAIN: Free heap size: 4358 K bytes

PSRAMのサイズが8Mあるのに、HEAPサイズが4M(4000K)しか増えない理由がこちらに書かれています。

On ESP32 only external SPI RAM under 4 MiB in size can be allocated this way.
To use the region above the 4 MiB limit, you can use the himem API.

ESP32 では、サイズが 4 MiB 未満の外部 SPI RAM のみをこの方法で割り当てることができます。
4 MiB 制限を超える領域を使用するには、himem APIを使用できます。

PSRAMの設定を何も行っていないsdkconfigと、PSRAMを有効にしたsdkconfigでは、これだけの差が有ります。
PSRAMを使う場合、これらの差分を全てsdkconfig.defaultに設定する必要が有ります。

$ diff sdkconfig sdkconfig.psram

              3c3

              < # Espressif IoT Development Framework (ESP-IDF) 
              Project Configuration

              ---

              > # Espressif IoT Development Framework (ESP-IDF) 5.1.2
              Project Configuration

              665d664

              < # CONFIG_ESP_SLEEP_POWER_DOWN_FLASH is not set

              666a666

              > CONFIG_ESP_SLEEP_PSRAM_LEAKAGE_WORKAROUND=y

              756c756,833

              < # CONFIG_SPIRAM is not set

              ---

              > CONFIG_SPIRAM=y

              >

              > #

              > # SPI RAM config

              > #

              > CONFIG_SPIRAM_MODE_QUAD=y

              > CONFIG_SPIRAM_TYPE_AUTO=y

              > # CONFIG_SPIRAM_TYPE_ESPPSRAM16 is not set

              > # CONFIG_SPIRAM_TYPE_ESPPSRAM32 is not set

              > # CONFIG_SPIRAM_TYPE_ESPPSRAM64 is not set

              > CONFIG_SPIRAM_SPEED_40M=y

              > CONFIG_SPIRAM_SPEED=40

              > CONFIG_SPIRAM_BOOT_INIT=y

              > CONFIG_SPIRAM_IGNORE_NOTFOUND=y

              > # CONFIG_SPIRAM_USE_MEMMAP is not set

              > # CONFIG_SPIRAM_USE_CAPS_ALLOC is not set

              > CONFIG_SPIRAM_USE_MALLOC=y

              > CONFIG_SPIRAM_MEMTEST=y

              > CONFIG_SPIRAM_MALLOC_ALWAYSINTERNAL=16384

              > # CONFIG_SPIRAM_TRY_ALLOCATE_WIFI_LWIP is not set

              > CONFIG_SPIRAM_MALLOC_RESERVE_INTERNAL=32768

              > # CONFIG_SPIRAM_ALLOW_BSS_SEG_EXTERNAL_MEMORY is not
              set

              > # CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY is
              not set

              > CONFIG_SPIRAM_CACHE_WORKAROUND=y

              >

              > #

              > # SPIRAM cache workaround debugging

              > #

              > CONFIG_SPIRAM_CACHE_WORKAROUND_STRATEGY_MEMW=y

              > # CONFIG_SPIRAM_CACHE_WORKAROUND_STRATEGY_DUPLDST is
              not set

              > # CONFIG_SPIRAM_CACHE_WORKAROUND_STRATEGY_NOPS is not
              set

              > # end of SPIRAM cache workaround debugging

              >

              > #

              > # SPIRAM workaround libraries placement

              > #

              > CONFIG_SPIRAM_CACHE_LIBJMP_IN_IRAM=y

              > CONFIG_SPIRAM_CACHE_LIBMATH_IN_IRAM=y

              > CONFIG_SPIRAM_CACHE_LIBNUMPARSER_IN_IRAM=y

              > CONFIG_SPIRAM_CACHE_LIBIO_IN_IRAM=y

              > CONFIG_SPIRAM_CACHE_LIBTIME_IN_IRAM=y

              > CONFIG_SPIRAM_CACHE_LIBCHAR_IN_IRAM=y

              > CONFIG_SPIRAM_CACHE_LIBMEM_IN_IRAM=y

              > CONFIG_SPIRAM_CACHE_LIBSTR_IN_IRAM=y

              > CONFIG_SPIRAM_CACHE_LIBRAND_IN_IRAM=y

              > CONFIG_SPIRAM_CACHE_LIBENV_IN_IRAM=y

              > CONFIG_SPIRAM_CACHE_LIBFILE_IN_IRAM=y

              > CONFIG_SPIRAM_CACHE_LIBMISC_IN_IRAM=y

              > # end of SPIRAM workaround libraries placement

              >

              > CONFIG_SPIRAM_BANKSWITCH_ENABLE=y

              > CONFIG_SPIRAM_BANKSWITCH_RESERVE=8

              > # CONFIG_SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY is not
              set

              >

              > #

              > # PSRAM clock and cs IO for ESP32-DOWD

              > #

              > CONFIG_D0WD_PSRAM_CLK_IO=17

              > CONFIG_D0WD_PSRAM_CS_IO=16

              > # end of PSRAM clock and cs IO for ESP32-DOWD

              >

              > #

              > # PSRAM clock and cs IO for ESP32-D2WD

              > #

              > CONFIG_D2WD_PSRAM_CLK_IO=9

              > CONFIG_D2WD_PSRAM_CS_IO=10

              > # end of PSRAM clock and cs IO for ESP32-D2WD

              >

              > #

              > # PSRAM clock and cs IO for ESP32-PICO-D4

              > #

              > CONFIG_PICO_PSRAM_CS_IO=10

              > # end of PSRAM clock and cs IO for ESP32-PICO-D4

              >

              > # CONFIG_SPIRAM_CUSTOM_SPIWP_SD3_PIN is not set

              > CONFIG_SPIRAM_SPIWP_SD3_PIN=7

              > # CONFIG_SPIRAM_2T_MODE is not set

              > # end of SPI RAM config

              849a927

              > CONFIG_ESP32_ECO3_CACHE_LOCK_FIX=y

              884,887c962,965

              < # CONFIG_ESP_WIFI_STATIC_TX_BUFFER is not set

              < CONFIG_ESP_WIFI_DYNAMIC_TX_BUFFER=y

              < CONFIG_ESP_WIFI_TX_BUFFER_TYPE=1

              < CONFIG_ESP_WIFI_DYNAMIC_TX_BUFFER_NUM=32

              ---

              > CONFIG_ESP_WIFI_STATIC_TX_BUFFER=y

              > CONFIG_ESP_WIFI_TX_BUFFER_TYPE=0

              > CONFIG_ESP_WIFI_STATIC_TX_BUFFER_NUM=16

              > CONFIG_ESP_WIFI_CACHE_TX_BUFFER_NUM=32

              896a975

              > # CONFIG_ESP_WIFI_AMSDU_TX_ENABLED is not set

              979a1059

              > CONFIG_FATFS_ALLOC_PREFER_EXTRAM=y

              1247a1328

              > # CONFIG_MBEDTLS_EXTERNAL_MEM_ALLOC is not set

              1658d1738

              < # CONFIG_ESP_SYSTEM_PD_FLASH is not set

              1680,1681c1760,1762

              < # CONFIG_SPIRAM_SUPPORT is not set

              < # CONFIG_ESP32_SPIRAM_SUPPORT is not set

              ---

              > CONFIG_SPIRAM_SUPPORT=y

              > CONFIG_ESP32_SPIRAM_SUPPORT=y

              > # CONFIG_WIFI_LWIP_ALLOCATION_FROM_SPIRAM_FIRST is
              not set

              1738,1741c1819,1822

              < # CONFIG_ESP32_WIFI_STATIC_TX_BUFFER is not set

              < CONFIG_ESP32_WIFI_DYNAMIC_TX_BUFFER=y

              < CONFIG_ESP32_WIFI_TX_BUFFER_TYPE=1

              < CONFIG_ESP32_WIFI_DYNAMIC_TX_BUFFER_NUM=32

              ---

              > CONFIG_ESP32_WIFI_STATIC_TX_BUFFER=y

              > CONFIG_ESP32_WIFI_TX_BUFFER_TYPE=0

              > CONFIG_ESP32_WIFI_STATIC_TX_BUFFER_NUM=16

              > CONFIG_ESP32_WIFI_CACHE_TX_BUFFER_NUM=32

              1748a1830

              > # CONFIG_ESP32_WIFI_AMSDU_TX_ENABLED is not set

PSRAMの設定はMenuconfigで行いますが、設定項目がESP32とESP32S3で違います。
こちらがESP32/ESP32S2の設定項目です。

こちらがESP32S3の設定項目です。

ESP32S3では、Quad Mode PSRAM と Octal Mode PSRAM の２種類のPSRAMを使うことが出来るようになりました。
MenuconfigでPSRAMを有効にすると Quad Mode PSRAM がデフォルトとなりますが、一部のESP32S3は Octal Mode PSRAMを採用しているので、
これを変えないとPSRAMが有効になりません。
EspressIFが提供するモジュールの場合、ESP32S3のデータシートにModeが明記されています。
例えばESP32-S3-WROOM-1のN4R2/N8R2/N16R2のPSRAMはQuad Modeですが、
ESP32-S3-WROOM-1のN4R8/N8R8/N8R8/N16R8のPSRAMはOctal Modeです。

EspressIF以外のベンダーが提供するモジュールの場合、PSRAMのModeがデータシートに明記されていないことが有ります。
私の持っているESP32S3開発ボードはAi-Thinkerが提供するESP-32-12Kのモジュールを使用していて、PSRAMが実装されていますが、
データシートにはPSRAMのModeまでは明記されていません。
この様な場合、Octal/Quad両方のモードを試してみないと、どちらが正解か分かりません。

Modeが有っていないと、以下の様にPSRAMのマウントに失敗し、PSRAMを認識しません。

I (171) cpu_start: Multicore app

              E (172) quad_psram: PSRAM ID read error: 0x00ffffff, PSRAM
              chip not found or not supported, or wrong PSRAM line mode

              E (175) esp_psram: PSRAM enabled but initialization
              failed. Bailing out.

              I (183) cpu_start: Failed to init external RAM; continuing
              without it.

              

              

              I (366) MAIN: PSRAM size: 0 bytes 0 Mbytes

              I (366) MAIN: MALLOC_CAP_SPIRAM: 0 bytes

              I (366) MAIN: Free heap size: 387728

Quad Mode/Octal Modeの変更は以下で行います。

Modeが正しいと、PARAMのマウントに成功します。

I (172) cpu_start: Multicore app

              

              I (225) esp_psram: Found 8MB PSRAM device

              I (230) esp_psram: Speed: 40MHz

              

              I (1161) MAIN: PSRAM size: 8388608 bytes 8 Mbytes

              I (1161) MAIN: MALLOC_CAP_SPIRAM: 8385720 bytes

              I (1171) MAIN: Free heap size: 8739704

Modeを変更するとsdkconfigにはこれだけの差分が出ます。

$ diff sdkconfig_quad sdkconfig_octal

              3c3

              < # Espressif IoT Development Framework (ESP-IDF) 
              Project Configuration

              ---

              > # Espressif IoT Development Framework (ESP-IDF) 5.1.2
              Project Configuration

              870,871c870,871

              < CONFIG_SPIRAM_MODE_QUAD=y

              < # CONFIG_SPIRAM_MODE_OCT is not set

              ---

              > # CONFIG_SPIRAM_MODE_QUAD is not set

              > CONFIG_SPIRAM_MODE_OCT=y

              873,874d872

              < # CONFIG_SPIRAM_TYPE_ESPPSRAM16 is not set

              < # CONFIG_SPIRAM_TYPE_ESPPSRAM32 is not set

              881d878

              < # CONFIG_SPIRAM_SPEED_120M is not set

              894a892

              > # CONFIG_SPIRAM_ECC_ENABLE is not set

ESP32CシリーズはPSRAMを使うことができません。但し、ESP32 C61だけは利用可能になりました。

続く．．．．