circuitpython/ports/espressif/common-hal/espidf/__init__.c

/*
 * This file is part of the MicroPython project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2022 Jeff Epler for Adafruit Industries
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include "bindings/espidf/__init__.h"
#include "supervisor/shared/translate/translate.h"
#include "supervisor/memory.h"
#include "py/runtime.h"

#include "esp_log.h"
#define TAG "espidf"

#ifdef CONFIG_SPIRAM
#include "esp32/spiram.h"
#include "esp_heap_caps.h"
#include "esp_heap_caps_init.h"
#include "soc/soc.h"
#ifdef CONFIG_IDF_TARGET_ESP32
#include "esp32/himem.h"
#else
#define esp_himem_reserved_area_size() (0)
#endif
bool ok_to_reserve_psram = true;
size_t reserved_psram = DEFAULT_RESERVED_PSRAM;
#endif

static size_t psram_size_usable(void) {
    #ifdef CONFIG_SPIRAM
    /* PSRAM chip may be larger than the size we can map into address space */
    size_t s = MIN(esp_spiram_get_size(), SOC_EXTRAM_DATA_SIZE);
    return s - esp_himem_reserved_area_size();
    #else
    return 0;
    #endif
}

bool common_hal_espidf_set_reserved_psram(size_t amount) {
    #ifdef CONFIG_SPIRAM
    if (!esp_spiram_is_initialized()) {
        return false;
    }
    if (!ok_to_reserve_psram) {
        return false;
    }
    if (amount > psram_size_usable()) {
        return false;
    }
    reserved_psram = amount;
    return true;
    #else
    return false;
    #endif
}

supervisor_allocation *psram_for_idf;

void common_hal_espidf_reserve_psram(void) {
    #ifdef CONFIG_SPIRAM
    if (!psram_for_idf) {
        ESP_LOGI(TAG, "Reserving %d bytes of psram", reserved_psram);
        if (reserved_psram == 0) {
            return;
        }
        psram_for_idf = allocate_memory(reserved_psram, true, false);
        if (psram_for_idf) {
            intptr_t psram_for_idf_start = (intptr_t)psram_for_idf->ptr;
            intptr_t psram_for_idf_end = psram_for_idf_start + reserved_psram;
            ESP_LOGI(TAG, "Reserved %x..%x", psram_for_idf_start, psram_for_idf_end);
            heap_caps_add_region(psram_for_idf_start, psram_for_idf_end);
        } else {
            ESP_LOGE(TAG, "supervisor allocation failed");
        }
    }
    #endif
}

size_t common_hal_espidf_get_reserved_psram(void) {
    #ifdef CONFIG_SPIRAM
    return reserved_psram;
    #else
    return 0;
    #endif
}

size_t common_hal_espidf_get_total_psram(void) {
    return psram_size_usable();
}

intptr_t common_hal_espidf_get_psram_start(void) {
    #ifdef CONFIG_SPIRAM
    if (esp_spiram_is_initialized()) {
        #ifdef CONFIG_IDF_TARGET_ESP32
        return SOC_EXTRAM_DATA_LOW;
        #else
        return SOC_EXTRAM_DATA_HIGH - psram_size_usable();
        #endif
    }
    #endif
    return 0;
}

intptr_t common_hal_espidf_get_psram_end(void) {
    #ifdef CONFIG_SPIRAM
    if (esp_spiram_is_initialized()) {
        return common_hal_espidf_get_psram_start() + psram_size_usable();
    }
    #endif
    return 0;
}

void raise_esp_error(esp_err_t err) {
    const compressed_string_t *msg = NULL;
    const mp_obj_type_t *exception_type = &mp_type_espidf_IDFError;
    switch (err) {
        case ESP_FAIL:
            msg = translate("Generic Failure");
            break;
        case ESP_ERR_NO_MEM:
            exception_type = &mp_type_espidf_MemoryError;
            msg = translate("Out of memory");
            break;
        case ESP_ERR_INVALID_ARG:
            msg = translate("Invalid argument");
            break;
        case ESP_ERR_INVALID_STATE:
            msg = translate("Invalid state");
            break;
        case ESP_ERR_INVALID_SIZE:
            msg = translate("Invalid size");
            break;
        case ESP_ERR_NOT_FOUND:
            msg = translate("Requested resource not found");
            break;
        case ESP_ERR_NOT_SUPPORTED:
            msg = translate("Operation or feature not supported");
            break;
        case ESP_ERR_TIMEOUT:
            msg = translate("Operation timed out");
            break;
        case ESP_ERR_INVALID_RESPONSE:
            msg = translate("Received response was invalid");
            break;
        case ESP_ERR_INVALID_CRC:
            msg = translate("CRC or checksum was invalid");
            break;
        case ESP_ERR_INVALID_VERSION:
            msg = translate("Version was invalid");
            break;
        case ESP_ERR_INVALID_MAC:
            msg = translate("MAC address was invalid");
            break;
    }
    if (msg) {
        mp_raise_msg(exception_type, msg);
    }

    const char *group = "ESP-IDF";

    // tests must be in descending order
    MP_STATIC_ASSERT(ESP_ERR_FLASH_BASE > ESP_ERR_MESH_BASE);
    MP_STATIC_ASSERT(ESP_ERR_MESH_BASE > ESP_ERR_WIFI_BASE);
    if (err >= ESP_ERR_FLASH_BASE) {
        group = "Flash";
    } else if (err >= ESP_ERR_MESH_BASE) {
        group = "Mesh";
    } else if (err >= ESP_ERR_WIFI_BASE) {
        group = "WiFi";
    }
    mp_raise_msg_varg(exception_type, translate("%s error 0x%x"), group, err);
}

MP_REGISTER_MODULE(MP_QSTR_espidf, espidf_module, CIRCUITPY_ESPIDF);