gustavonihei commented on a change in pull request #5827: URL: https://github.com/apache/incubator-nuttx/pull/5827#discussion_r833222532
########## File path: arch/xtensa/src/esp32s2/esp32s2_spiram.h ########## @@ -0,0 +1,206 @@ +/**************************************************************************** + * arch/xtensa/src/esp32s2/esp32s2_spiram.h + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. The + * ASF licenses this file to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#ifndef __ARCH_XTENSA_SRC_ESP32S2_ESP32S2_SPIRAM_H +#define __ARCH_XTENSA_SRC_ESP32S2_ESP32S2_SPIRAM_H + +#include <stddef.h> +#include <stdint.h> +#include <stdbool.h> + +#ifdef __cplusplus +extern "C" +{ +#endif + +/* @brief Initialize spiram interface/hardware. Normally called from + * cpu_start.c. + * + * @return ESP_OK on success + */ + +int esp_spiram_init(void); + +/** + * @brief Configure Cache/MMU for access to external SPI RAM. + * + * Normally this function is called from cpu_start, if + * CONFIG_SPIRAM_BOOT_INIT option is enabled. Applications which need to + * enable SPI RAM at run time can disable CONFIG_SPIRAM_BOOT_INIT, and + * call this function later. + * + * @attention this function must be called with flash cache disabled. + */ + +void esp_spiram_init_cache(void); + +/** + * @brief Memory test for SPI RAM. Should be called after SPI RAM is + * initialized and (in case of a dual-core system) the app CPU is online. + * This test overwrites the memory with crap, so do not call after e.g. the + * heap allocator has stored important stuff in SPI RAM. + * + * @return true on success, false on failed memory test + */ + +bool esp_spiram_test(void); + +/** + * @brief Add the initialized SPI RAM to the heap allocator. + */ + +int esp_spiram_add_to_heapalloc(void); + +/** + * @brief Get the available physical size of the attached SPI RAM chip + * + * @note If ECC is enabled, the available physical size would be smaller + * than the physical size. See `CONFIG_SPIRAM_ECC_ENABLE` + * + * @return Size in bytes, or 0 if no external RAM chip support compiled in. + */ + +size_t esp_spiram_get_size(void); + +/** + * @brief Force a writeback of the data in the SPI RAM cache. This is to be + * called whenever cache is disabled, because disabling cache on the ESP32 + * discards the data in the SPI RAM cache. + * + * This is meant for use from within the SPI flash code. + */ + +void esp_spiram_writeback_cache(void); + +/** + * @brief If SPI RAM(PSRAM) has been initialized + * + * @return + * - true SPI RAM has been initialized successfully + * - false SPI RAM hasn't been initialized or initialized failed + */ + +bool esp_spiram_is_initialized(void); + +/** + * @brief get psram CS IO + * + * This interface should be called after PSRAM is enabled, otherwise it will + * return an invalid value -1/0xff. + * + * @return psram CS IO or -1/0xff if psram not enabled + */ + +uint8_t esp_spiram_get_cs_io(void); + +/** + * @brief Reserve a pool of internal memory for specific DMA/internal + * allocations + * + * @param size Size of reserved pool in bytes + * + * @return + * - ESP_OK on success + * - ESP_ERR_NO_MEM when no memory available for pool + */ + +int esp_spiram_reserve_dma_pool(size_t size); + +/** + * @brief If SPI RAM(PSRAM) has been initialized + * + * @return + * - true SPI RAM has been initialized successfully + * - false SPI RAM hasn't been initialized or initialized failed + */ + +bool esp_spiram_is_initialized(void); + +#if defined(CONFIG_ESP32S2_SPIRAM_FETCH_INSTRUCTIONS) Review comment: The definition for `ESP32S2_SPIRAM_FETCH_INSTRUCTIONS` Kconfig option seems to be missing. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@nuttx.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
