223 lines
5.5 KiB
C
223 lines
5.5 KiB
C
/****************************************************************************
|
|
* arch/xtensa/src/esp32s3/esp32s3_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_ESP32S3_ESP32S3_SPIRAM_H
|
|
#define __ARCH_XTENSA_SRC_ESP32S3_ESP32S3_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_ESP32S3_SPIRAM_FETCH_INSTRUCTIONS)
|
|
|
|
extern uint8_t _instruction_reserved_start[];
|
|
extern uint8_t _instruction_reserved_end[];
|
|
|
|
/**
|
|
* @brief Get the start page number of the instruction in SPI flash
|
|
*
|
|
* @return start page number
|
|
*/
|
|
|
|
uint32_t instruction_flash_start_page_get(void);
|
|
|
|
/**
|
|
* @brief Get the end page number of the instruction in SPI flash
|
|
*
|
|
* @return end page number
|
|
*/
|
|
|
|
uint32_t instruction_flash_end_page_get(void);
|
|
|
|
/**
|
|
* @brief Get the offset of instruction from SPI flash to SPI RAM
|
|
*
|
|
* @return instruction offset
|
|
*/
|
|
|
|
int instruction_flash2spiram_offset(void);
|
|
|
|
#endif
|
|
|
|
#if defined(CONFIG_SPIRAM_RODATA)
|
|
|
|
extern uint8_t _rodata_reserved_start[];
|
|
extern uint8_t _rodata_reserved_end[];
|
|
|
|
/**
|
|
* @brief Get the start page number of the rodata in SPI flash
|
|
*
|
|
* @return start page number
|
|
*/
|
|
|
|
uint32_t rodata_flash_start_page_get(void);
|
|
|
|
/**
|
|
* @brief Get the end page number of the rodata in SPI flash
|
|
*
|
|
* @return end page number
|
|
*/
|
|
|
|
uint32_t rodata_flash_end_page_get(void);
|
|
|
|
/**
|
|
* @brief Get the offset number of rodata from SPI flash to SPI RAM
|
|
*
|
|
* @return rodata offset
|
|
*/
|
|
|
|
int rodata_flash2spiram_offset(void);
|
|
|
|
#endif
|
|
|
|
/**
|
|
* @brief Get allocable virtual start address
|
|
*
|
|
* @return Allocable virtual start address
|
|
*/
|
|
|
|
uint32_t esp_spiram_allocable_vaddr_start(void);
|
|
|
|
/**
|
|
* @brief Get allocable virtual end address
|
|
*
|
|
* @return Allocable virtual end address
|
|
*/
|
|
|
|
uint32_t esp_spiram_allocable_vaddr_end(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|