mirror of
https://github.com/espressif/esp-idf.git
synced 2025-08-10 04:43:33 +00:00
spi_flash: move cache stuff to private
This commit is contained in:
85
components/spi_flash/include/esp_private/cache_utils.h
Normal file
85
components/spi_flash/include/esp_private/cache_utils.h
Normal file
@@ -0,0 +1,85 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "sdkconfig.h"
|
||||
#include <stdbool.h>
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* This header file contains declarations of cache manipulation functions
|
||||
* used both in flash_ops.c and flash_mmap.c.
|
||||
*
|
||||
* These functions are considered internal and are not designed to be called from applications.
|
||||
*/
|
||||
|
||||
// Init mutex protecting access to spi_flash_* APIs
|
||||
void spi_flash_init_lock(void);
|
||||
|
||||
// Take mutex protecting access to spi_flash_* APIs
|
||||
void spi_flash_op_lock(void);
|
||||
|
||||
// Release said mutex
|
||||
void spi_flash_op_unlock(void);
|
||||
|
||||
// Suspend the scheduler on both CPUs, disable cache.
|
||||
// Contrary to its name this doesn't do anything with interrupts, yet.
|
||||
// Interrupt disabling capability will be added once we implement
|
||||
// interrupt allocation API.
|
||||
void spi_flash_disable_interrupts_caches_and_other_cpu(void);
|
||||
|
||||
// Enable cache, enable interrupts (to be added in future), resume scheduler
|
||||
void spi_flash_enable_interrupts_caches_and_other_cpu(void);
|
||||
|
||||
// Disables non-IRAM interrupt handlers on current CPU and caches on both CPUs.
|
||||
// This function is implied to be called when other CPU is not running or running code from IRAM.
|
||||
void spi_flash_disable_interrupts_caches_and_other_cpu_no_os(void);
|
||||
|
||||
// Enable cache, enable interrupts on current CPU.
|
||||
// This function is implied to be called when other CPU is not running or running code from IRAM.
|
||||
void spi_flash_enable_interrupts_caches_no_os(void);
|
||||
|
||||
// Mark the pages containing a flash region as having been
|
||||
// erased or written to. This means the flash cache needs
|
||||
// to be evicted before these pages can be flash_mmap()ed again,
|
||||
// as they may contain stale data
|
||||
//
|
||||
// Only call this while holding spi_flash_op_lock()
|
||||
// Returns true if cache was flushed, false otherwise
|
||||
bool spi_flash_check_and_flush_cache(size_t start_addr, size_t length);
|
||||
|
||||
//config cache mode
|
||||
#if !CONFIG_IDF_TARGET_ESP32
|
||||
//config instrcutin cache size and cache block size by menuconfig
|
||||
void esp_config_instruction_cache_mode(void);
|
||||
//config data cache size and cache block size by menuconfig
|
||||
void esp_config_data_cache_mode(void);
|
||||
//enable cache wrap mode for instruction cache and data cache
|
||||
esp_err_t esp_enable_cache_wrap(bool icache_wrap_enable, bool dcache_wrap_enable);
|
||||
#endif
|
||||
|
||||
/** @brief Check at runtime if flash cache is enabled on both CPUs
|
||||
*
|
||||
* @return true if both CPUs have flash cache enabled, false otherwise.
|
||||
*/
|
||||
bool spi_flash_cache_enabled(void);
|
||||
|
||||
/**
|
||||
* @brief Re-enable cache for the core defined as cpuid parameter.
|
||||
*
|
||||
* @param cpuid the core number to enable instruction cache for
|
||||
*/
|
||||
void spi_flash_enable_cache(uint32_t cpuid);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
Reference in New Issue
Block a user