mirror of
				https://github.com/espressif/esp-idf.git
				synced 2025-11-04 06:11:06 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			75 lines
		
	
	
		
			2.8 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			75 lines
		
	
	
		
			2.8 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
 | 
						|
//
 | 
						|
// Licensed 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.
 | 
						|
 | 
						|
#ifndef ESP_SPI_FLASH_CACHE_UTILS_H
 | 
						|
#define ESP_SPI_FLASH_CACHE_UTILS_H
 | 
						|
 | 
						|
#include "sdkconfig.h"
 | 
						|
#include <stdbool.h>
 | 
						|
 | 
						|
/**
 | 
						|
 * 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
 | 
						|
 | 
						|
 | 
						|
#endif //ESP_SPI_FLASH_CACHE_UTILS_H
 |