mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
a9fda54d39
This commit updates the visibility of various header files and cleans up some unnecessary inclusions. Also, this commit removes certain header include paths which were maintained for backward compatibility.
324 lines
11 KiB
C
324 lines
11 KiB
C
/*
|
|
Abstraction layer for spi-ram. For now, it's no more than a stub for the spiram_psram functions, but if
|
|
we add more types of external RAM memory, this can be made into a more intelligent dispatcher.
|
|
*/
|
|
|
|
/*
|
|
* SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#include <stdint.h>
|
|
#include <string.h>
|
|
#include <sys/param.h>
|
|
|
|
#include "sdkconfig.h"
|
|
#include "esp_attr.h"
|
|
#include "esp_err.h"
|
|
#include "esp32/spiram.h"
|
|
#include "spiram_psram.h"
|
|
#include "esp_log.h"
|
|
#include "freertos/FreeRTOS.h"
|
|
#include "freertos/xtensa_api.h"
|
|
#include "soc/soc.h"
|
|
#include "esp_heap_caps_init.h"
|
|
#include "soc/soc_memory_layout.h"
|
|
#include "soc/dport_reg.h"
|
|
#include "esp_himem.h"
|
|
#include "esp32/rom/cache.h"
|
|
|
|
#if CONFIG_FREERTOS_UNICORE
|
|
#define PSRAM_MODE PSRAM_VADDR_MODE_NORMAL
|
|
#else
|
|
#if CONFIG_MEMMAP_SPIRAM_CACHE_EVENODD
|
|
#define PSRAM_MODE PSRAM_VADDR_MODE_EVENODD
|
|
#else
|
|
#define PSRAM_MODE PSRAM_VADDR_MODE_LOWHIGH
|
|
#endif
|
|
#endif
|
|
|
|
#if CONFIG_SPIRAM
|
|
|
|
static const char* TAG = "spiram";
|
|
|
|
#if CONFIG_SPIRAM_SPEED_40M && CONFIG_ESPTOOLPY_FLASHFREQ_40M
|
|
#define PSRAM_SPEED PSRAM_CACHE_F40M_S40M
|
|
#elif CONFIG_SPIRAM_SPEED_40M && CONFIG_ESPTOOLPY_FLASHFREQ_80M
|
|
#define PSRAM_SPEED PSRAM_CACHE_F80M_S40M
|
|
#elif CONFIG_SPIRAM_SPEED_80M && CONFIG_ESPTOOLPY_FLASHFREQ_80M
|
|
#define PSRAM_SPEED PSRAM_CACHE_F80M_S80M
|
|
#else
|
|
#error "FLASH speed can only be equal to or higher than SRAM speed while SRAM is enabled!"
|
|
#endif
|
|
|
|
#if CONFIG_SPIRAM_ALLOW_BSS_SEG_EXTERNAL_MEMORY
|
|
extern uint8_t _ext_ram_bss_start, _ext_ram_bss_end;
|
|
#endif
|
|
#if CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY
|
|
extern uint8_t _ext_ram_noinit_start, _ext_ram_noinit_end;
|
|
#endif
|
|
|
|
static bool spiram_inited=false;
|
|
|
|
|
|
//If no function in esp_himem.c is used, this function will be linked into the
|
|
//binary instead of the one in esp_himem.c, automatically making sure no memory
|
|
//is reserved if no himem function is used.
|
|
size_t __attribute__((weak)) esp_himem_reserved_area_size(void) {
|
|
return 0;
|
|
}
|
|
|
|
|
|
static size_t spiram_size_usable_for_malloc(void)
|
|
{
|
|
/* SPIRAM 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();
|
|
}
|
|
|
|
|
|
/*
|
|
Simple RAM test. Writes a word every 32 bytes. Takes about a second to complete for 4MiB. Returns
|
|
true when RAM seems OK, false when test fails. WARNING: Do not run this before the 2nd cpu has been
|
|
initialized (in a two-core system) or after the heap allocator has taken ownership of the memory.
|
|
*/
|
|
bool esp_spiram_test(void)
|
|
{
|
|
|
|
#if CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY
|
|
const void *keepout_addr_low = (const void*)&_ext_ram_noinit_start;
|
|
const void *keepout_addr_high = (const void*)&_ext_ram_noinit_end;
|
|
#else
|
|
const void *keepout_addr_low = 0;
|
|
const void *keepout_addr_high = 0;
|
|
#endif
|
|
|
|
volatile int *spiram=(volatile int*)SOC_EXTRAM_DATA_LOW;
|
|
size_t p;
|
|
size_t s=spiram_size_usable_for_malloc();
|
|
int errct=0;
|
|
int initial_err=-1;
|
|
for (p=0; p<(s/sizeof(int)); p+=8) {
|
|
const void *addr = (const void *)&spiram[p];
|
|
if ((keepout_addr_low <= addr) && (addr < keepout_addr_high)) {
|
|
continue;
|
|
}
|
|
spiram[p]=p^0xAAAAAAAA;
|
|
}
|
|
for (p=0; p<(s/sizeof(int)); p+=8) {
|
|
const void *addr = (const void *)&spiram[p];
|
|
if ((keepout_addr_low <= addr) && (addr < keepout_addr_high)) {
|
|
continue;
|
|
}
|
|
if (spiram[p]!=(p^0xAAAAAAAA)) {
|
|
errct++;
|
|
if (errct==1) initial_err=p*4;
|
|
}
|
|
}
|
|
if (errct) {
|
|
ESP_EARLY_LOGE(TAG, "SPI SRAM memory test fail. %d/%d writes failed, first @ %X\n", errct, s/32, initial_err+SOC_EXTRAM_DATA_LOW);
|
|
return false;
|
|
} else {
|
|
ESP_EARLY_LOGI(TAG, "SPI SRAM memory test OK");
|
|
return true;
|
|
}
|
|
}
|
|
|
|
void IRAM_ATTR esp_spiram_init_cache(void)
|
|
{
|
|
int size = esp_spiram_get_size();
|
|
if (size > 4 * 1024 * 1024) size = 4 * 1024 * 1024; // we can map at most 4MByte
|
|
//Enable external RAM in MMU
|
|
cache_sram_mmu_set(0, 0, SOC_EXTRAM_DATA_LOW, 0, 32, (size / 1024 / 32));
|
|
//Flush and enable icache for APP CPU
|
|
#if !CONFIG_FREERTOS_UNICORE
|
|
DPORT_CLEAR_PERI_REG_MASK(DPORT_APP_CACHE_CTRL1_REG, DPORT_APP_CACHE_MASK_DRAM1);
|
|
cache_sram_mmu_set(1, 0, SOC_EXTRAM_DATA_LOW, 0, 32, (size / 1024 / 32));
|
|
#endif
|
|
}
|
|
|
|
esp_spiram_size_t esp_spiram_get_chip_size(void)
|
|
{
|
|
if (!spiram_inited) {
|
|
ESP_EARLY_LOGE(TAG, "SPI RAM not initialized");
|
|
abort();
|
|
}
|
|
psram_size_t psram_size = psram_get_size();
|
|
switch (psram_size) {
|
|
case PSRAM_SIZE_16MBITS:
|
|
return ESP_SPIRAM_SIZE_16MBITS;
|
|
case PSRAM_SIZE_32MBITS:
|
|
return ESP_SPIRAM_SIZE_32MBITS;
|
|
case PSRAM_SIZE_64MBITS:
|
|
return ESP_SPIRAM_SIZE_64MBITS;
|
|
default:
|
|
return ESP_SPIRAM_SIZE_INVALID;
|
|
}
|
|
}
|
|
|
|
esp_err_t esp_spiram_init(void)
|
|
{
|
|
esp_err_t r;
|
|
r = psram_enable(PSRAM_SPEED, PSRAM_MODE);
|
|
if (r != ESP_OK) {
|
|
#if CONFIG_SPIRAM_IGNORE_NOTFOUND
|
|
ESP_EARLY_LOGE(TAG, "SPI RAM enabled but initialization failed. Bailing out.");
|
|
#endif
|
|
return r;
|
|
}
|
|
|
|
spiram_inited=true; //note: this needs to be set before esp_spiram_get_chip_*/esp_spiram_get_size calls
|
|
#if (CONFIG_SPIRAM_SIZE != -1)
|
|
if (esp_spiram_get_size()!=CONFIG_SPIRAM_SIZE) {
|
|
ESP_EARLY_LOGE(TAG, "Expected %dKiB chip but found %dKiB chip. Bailing out..", CONFIG_SPIRAM_SIZE/1024, esp_spiram_get_size()/1024);
|
|
return ESP_ERR_INVALID_SIZE;
|
|
}
|
|
#endif
|
|
|
|
ESP_EARLY_LOGI(TAG, "Found %dMBit SPI RAM device",
|
|
(esp_spiram_get_size()*8)/(1024*1024));
|
|
ESP_EARLY_LOGI(TAG, "SPI RAM mode: %s", PSRAM_SPEED == PSRAM_CACHE_F40M_S40M ? "flash 40m sram 40m" : \
|
|
PSRAM_SPEED == PSRAM_CACHE_F80M_S40M ? "flash 80m sram 40m" : \
|
|
PSRAM_SPEED == PSRAM_CACHE_F80M_S80M ? "flash 80m sram 80m" : "ERROR");
|
|
ESP_EARLY_LOGI(TAG, "PSRAM initialized, cache is in %s mode.", \
|
|
(PSRAM_MODE==PSRAM_VADDR_MODE_EVENODD)?"even/odd (2-core)": \
|
|
(PSRAM_MODE==PSRAM_VADDR_MODE_LOWHIGH)?"low/high (2-core)": \
|
|
(PSRAM_MODE==PSRAM_VADDR_MODE_NORMAL)?"normal (1-core)":"ERROR");
|
|
return ESP_OK;
|
|
}
|
|
|
|
|
|
esp_err_t esp_spiram_add_to_heapalloc(void)
|
|
{
|
|
//Add entire external RAM region to heap allocator. Heap allocator knows the capabilities of this type of memory, so there's
|
|
//no need to explicitly specify them.
|
|
intptr_t mallocable_ram_start = (intptr_t)SOC_EXTRAM_DATA_LOW;
|
|
#if CONFIG_SPIRAM_ALLOW_BSS_SEG_EXTERNAL_MEMORY
|
|
if (mallocable_ram_start < (intptr_t)&_ext_ram_bss_end) {
|
|
mallocable_ram_start = (intptr_t)&_ext_ram_bss_end;
|
|
}
|
|
#endif
|
|
#if CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY
|
|
if (mallocable_ram_start < (intptr_t)&_ext_ram_noinit_end) {
|
|
mallocable_ram_start = (intptr_t)&_ext_ram_noinit_end;
|
|
}
|
|
#endif
|
|
intptr_t mallocable_ram_end = (intptr_t)SOC_EXTRAM_DATA_LOW + spiram_size_usable_for_malloc() - 1;
|
|
ESP_EARLY_LOGI(TAG, "Adding pool of %dK of external SPI memory to heap allocator", (mallocable_ram_end - mallocable_ram_start)/1024);
|
|
return heap_caps_add_region(mallocable_ram_start, mallocable_ram_end);
|
|
}
|
|
|
|
|
|
static uint8_t *dma_heap;
|
|
|
|
esp_err_t esp_spiram_reserve_dma_pool(size_t size) {
|
|
ESP_EARLY_LOGI(TAG, "Reserving pool of %dK of internal memory for DMA/internal allocations", size/1024);
|
|
/* Pool may be allocated in multiple non-contiguous chunks, depending on available RAM */
|
|
while (size > 0) {
|
|
size_t next_size = heap_caps_get_largest_free_block(MALLOC_CAP_DMA|MALLOC_CAP_INTERNAL);
|
|
next_size = MIN(next_size, size);
|
|
|
|
ESP_EARLY_LOGD(TAG, "Allocating block of size %d bytes", next_size);
|
|
dma_heap = heap_caps_malloc(next_size, MALLOC_CAP_DMA|MALLOC_CAP_INTERNAL);
|
|
if (!dma_heap || next_size == 0) {
|
|
return ESP_ERR_NO_MEM;
|
|
}
|
|
|
|
uint32_t caps[] = { 0, MALLOC_CAP_DMA|MALLOC_CAP_INTERNAL, MALLOC_CAP_8BIT|MALLOC_CAP_32BIT };
|
|
esp_err_t e = heap_caps_add_region_with_caps(caps, (intptr_t) dma_heap, (intptr_t) dma_heap+next_size-1);
|
|
if (e != ESP_OK) {
|
|
return e;
|
|
}
|
|
size -= next_size;
|
|
}
|
|
return ESP_OK;
|
|
}
|
|
|
|
size_t esp_spiram_get_size(void)
|
|
{
|
|
psram_size_t size=esp_spiram_get_chip_size();
|
|
if (size==PSRAM_SIZE_16MBITS) return 2*1024*1024;
|
|
if (size==PSRAM_SIZE_32MBITS) return 4*1024*1024;
|
|
if (size==PSRAM_SIZE_64MBITS) return 8*1024*1024;
|
|
return CONFIG_SPIRAM_SIZE;
|
|
}
|
|
|
|
/*
|
|
Before flushing the cache, if psram is enabled as a memory-mapped thing, we need to write back the data in the cache to the psram first,
|
|
otherwise it will get lost. For now, we just read 64/128K of random PSRAM memory to do this.
|
|
Note that this routine assumes some unique mapping for the first 2 banks of the PSRAM memory range, as well as the
|
|
2 banks after the 2 MiB mark.
|
|
*/
|
|
void IRAM_ATTR esp_spiram_writeback_cache(void)
|
|
{
|
|
int x;
|
|
volatile int i=0;
|
|
volatile uint8_t *psram=(volatile uint8_t*)SOC_EXTRAM_DATA_LOW;
|
|
int cache_was_disabled=0;
|
|
|
|
if (!spiram_inited) return;
|
|
|
|
//We need cache enabled for this to work. Re-enable it if needed; make sure we
|
|
//disable it again on exit as well.
|
|
if (DPORT_REG_GET_BIT(DPORT_PRO_CACHE_CTRL_REG, DPORT_PRO_CACHE_ENABLE)==0) {
|
|
cache_was_disabled|=(1<<0);
|
|
DPORT_SET_PERI_REG_BITS(DPORT_PRO_CACHE_CTRL_REG, 1, 1, DPORT_PRO_CACHE_ENABLE_S);
|
|
}
|
|
#ifndef CONFIG_FREERTOS_UNICORE
|
|
if (DPORT_REG_GET_BIT(DPORT_APP_CACHE_CTRL_REG, DPORT_APP_CACHE_ENABLE)==0) {
|
|
cache_was_disabled|=(1<<1);
|
|
DPORT_SET_PERI_REG_BITS(DPORT_APP_CACHE_CTRL_REG, 1, 1, DPORT_APP_CACHE_ENABLE_S);
|
|
}
|
|
#endif
|
|
|
|
#if (PSRAM_MODE != PSRAM_VADDR_MODE_LOWHIGH)
|
|
/*
|
|
Single-core and even/odd mode only have 32K of cache evenly distributed over the address lines. We can clear
|
|
the cache by just reading 64K worth of cache lines.
|
|
*/.
|
|
for (x=0; x<1024*64; x+=32) {
|
|
i+=psram[x];
|
|
}
|
|
#else
|
|
/*
|
|
Low/high psram cache mode uses one 32K cache for the lowest 2MiB of SPI flash and another 32K for the highest
|
|
2MiB. Clear this by reading from both regions.
|
|
Note: this assumes the amount of external RAM is >2M. If it is 2M or less, what this code does is undefined. If
|
|
we ever support external RAM chips of 2M or smaller, this may need adjusting.
|
|
*/
|
|
for (x=0; x<1024*64; x+=32) {
|
|
i+=psram[x];
|
|
i+=psram[x+(1024*1024*2)];
|
|
}
|
|
#endif
|
|
|
|
if (cache_was_disabled&(1<<0)) {
|
|
while (DPORT_GET_PERI_REG_BITS2(DPORT_PRO_DCACHE_DBUG0_REG, DPORT_PRO_CACHE_STATE, DPORT_PRO_CACHE_STATE_S) != 1) ;
|
|
DPORT_SET_PERI_REG_BITS(DPORT_PRO_CACHE_CTRL_REG, 1, 0, DPORT_PRO_CACHE_ENABLE_S);
|
|
}
|
|
#ifndef CONFIG_FREERTOS_UNICORE
|
|
if (cache_was_disabled&(1<<1)) {
|
|
while (DPORT_GET_PERI_REG_BITS2(DPORT_APP_DCACHE_DBUG0_REG, DPORT_APP_CACHE_STATE, DPORT_APP_CACHE_STATE_S) != 1);
|
|
DPORT_SET_PERI_REG_BITS(DPORT_APP_CACHE_CTRL_REG, 1, 0, DPORT_APP_CACHE_ENABLE_S);
|
|
}
|
|
#endif
|
|
}
|
|
|
|
/**
|
|
* @brief If SPI RAM(PSRAM) has been initialized
|
|
*
|
|
* @return true SPI RAM has been initialized successfully
|
|
* @return false SPI RAM hasn't been initialized or initialized failed
|
|
*/
|
|
bool esp_spiram_is_initialized(void)
|
|
{
|
|
return spiram_inited;
|
|
}
|
|
|
|
uint8_t esp_spiram_get_cs_io(void)
|
|
{
|
|
return psram_get_cs_io();
|
|
}
|
|
#endif
|