548 lines
13 KiB
C
548 lines
13 KiB
C
/****************************************************************************
|
|
* include/nuttx/cache.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.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __INCLUDE_NUTTX_CACHE_H
|
|
#define __INCLUDE_NUTTX_CACHE_H
|
|
|
|
#ifndef __ASSEMBLY__
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <stdint.h>
|
|
#include <sys/types.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: up_get_icache_linesize
|
|
*
|
|
* Description:
|
|
* Get icache linesize
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* Cache line size
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_ICACHE
|
|
size_t up_get_icache_linesize(void);
|
|
#else
|
|
# define up_get_icache_linesize() 0
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_get_icache_size
|
|
*
|
|
* Description:
|
|
* Get icache size
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* Cache size
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_ICACHE
|
|
size_t up_get_icache_size(void);
|
|
#else
|
|
# define up_get_icache_size() 0
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_enable_icache
|
|
*
|
|
* Description:
|
|
* Enable the I-Cache
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
* Caution:
|
|
* The writable global variables aren't initialized yet.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_ICACHE
|
|
void up_enable_icache(void);
|
|
#else
|
|
# define up_enable_icache()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_disable_icache
|
|
*
|
|
* Description:
|
|
* Disable the I-Cache
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_ICACHE
|
|
void up_disable_icache(void);
|
|
#else
|
|
# define up_disable_icache()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_invalidate_icache
|
|
*
|
|
* Description:
|
|
* Invalidate the instruction cache within the specified region.
|
|
*
|
|
* Input Parameters:
|
|
* start - virtual start address of region
|
|
* end - virtual end address of region + 1
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_ICACHE
|
|
void up_invalidate_icache(uintptr_t start, uintptr_t end);
|
|
#else
|
|
# define up_invalidate_icache(start, end)
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_invalidate_icache_all
|
|
*
|
|
* Description:
|
|
* Invalidate the entire contents of I cache.
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_ICACHE
|
|
void up_invalidate_icache_all(void);
|
|
#else
|
|
# define up_invalidate_icache_all()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_lock_icache
|
|
*
|
|
* Description:
|
|
* Prefetch and lock the instruction cache within the specified region.
|
|
* If the specified address if not present in the instruction cache,
|
|
* some architectures transfer the line from memory, others wait the
|
|
* address be read from memory, and then lock.
|
|
*
|
|
* Input Parameters:
|
|
* start - virtual start address of region
|
|
* end - virtual end address of region + 1
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_ICACHE_LOCK
|
|
void up_lock_icache(uintptr_t start, uintptr_t end);
|
|
#else
|
|
# define up_lock_icache()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_unlock_icache
|
|
*
|
|
* Description:
|
|
* Unlock the instruction cache within the specified region.
|
|
*
|
|
* Input Parameters:
|
|
* start - virtual start address of region
|
|
* end - virtual end address of region + 1
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_ICACHE_LOCK
|
|
void up_unlock_icache(uintptr_t start, uintptr_t end);
|
|
#else
|
|
# define up_unlock_icache()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_unlock_icache_all
|
|
*
|
|
* Description:
|
|
* Unlock the entire contents of instruction cache.
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_ICACHE_LOCK
|
|
void up_unlock_icache_all(void);
|
|
#else
|
|
# define up_unlock_icache_all()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_get_dcache_linesize
|
|
*
|
|
* Description:
|
|
* Get dcache linesize
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* Cache line size
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_DCACHE
|
|
size_t up_get_dcache_linesize(void);
|
|
#else
|
|
# define up_get_dcache_linesize() 0
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_get_dcache_size
|
|
*
|
|
* Description:
|
|
* Get dcache size
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* Cache size
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_DCACHE
|
|
size_t up_get_dcache_size(void);
|
|
#else
|
|
# define up_get_dcache_size() 0
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_enable_dcache
|
|
*
|
|
* Description:
|
|
* Enable the D-Cache
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
* Caution:
|
|
* The writable global variables aren't initialized yet.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_DCACHE
|
|
void up_enable_dcache(void);
|
|
#else
|
|
# define up_enable_dcache()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_disable_dcache
|
|
*
|
|
* Description:
|
|
* Disable the D-Cache
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_DCACHE
|
|
void up_disable_dcache(void);
|
|
#else
|
|
# define up_disable_dcache()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_invalidate_dcache
|
|
*
|
|
* Description:
|
|
* Invalidate the data cache within the specified region; we will be
|
|
* performing a DMA operation in this region and we want to purge old data
|
|
* in the cache.
|
|
*
|
|
* Input Parameters:
|
|
* start - virtual start address of region
|
|
* end - virtual end address of region + 1
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_DCACHE
|
|
void up_invalidate_dcache(uintptr_t start, uintptr_t end);
|
|
#else
|
|
# define up_invalidate_dcache(start, end)
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_invalidate_dcache_all
|
|
*
|
|
* Description:
|
|
* Invalidate the entire contents of D cache.
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_DCACHE
|
|
void up_invalidate_dcache_all(void);
|
|
#else
|
|
# define up_invalidate_dcache_all()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_clean_dcache
|
|
*
|
|
* Description:
|
|
* Clean the data cache within the specified region by flushing the
|
|
* contents of the data cache to memory.
|
|
*
|
|
* Input Parameters:
|
|
* start - virtual start address of region
|
|
* end - virtual end address of region + 1
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_DCACHE
|
|
void up_clean_dcache(uintptr_t start, uintptr_t end);
|
|
#else
|
|
# define up_clean_dcache(start, end)
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_clean_dcache_all
|
|
*
|
|
* Description:
|
|
* Clean the entire data cache within the specified region by flushing the
|
|
* contents of the data cache to memory.
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_DCACHE
|
|
void up_clean_dcache_all(void);
|
|
#else
|
|
# define up_clean_dcache_all()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_flush_dcache
|
|
*
|
|
* Description:
|
|
* Flush the data cache within the specified region by cleaning and
|
|
* invalidating the D cache.
|
|
*
|
|
* Input Parameters:
|
|
* start - virtual start address of region
|
|
* end - virtual end address of region + 1
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_DCACHE
|
|
void up_flush_dcache(uintptr_t start, uintptr_t end);
|
|
#else
|
|
# define up_flush_dcache(start, end)
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_flush_dcache_all
|
|
*
|
|
* Description:
|
|
* Flush the entire data cache by cleaning and invalidating the D cache.
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_DCACHE
|
|
void up_flush_dcache_all(void);
|
|
#else
|
|
# define up_flush_dcache_all()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_lock_dcache
|
|
*
|
|
* Description:
|
|
* Prefetch and lock the data cache within the specified region.
|
|
* If the specified address is not present in the data cache,
|
|
* some architectures transfer the line from memory, others wait the
|
|
* address be read from memory, and then lock.
|
|
*
|
|
* Input Parameters:
|
|
* start - virtual start address of region
|
|
* end - virtual end address of region + 1
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_DCACHE_LOCK
|
|
void up_lock_dcache(uintptr_t start, uintptr_t end);
|
|
#else
|
|
# define up_lock_dcache()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_unlock_dcache
|
|
*
|
|
* Description:
|
|
* Unlock the data cache within the specified region.
|
|
*
|
|
* Input Parameters:
|
|
* start - virtual start address of region
|
|
* end - virtual end address of region + 1
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_DCACHE_LOCK
|
|
void up_unlock_dcache(uintptr_t start, uintptr_t end);
|
|
#else
|
|
# define up_unlock_dcache()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_unlock_dcache_all
|
|
*
|
|
* Description:
|
|
* Unlock the entire contents of data cache.
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_DCACHE_LOCK
|
|
void up_unlock_dcache_all(void);
|
|
#else
|
|
# define up_unlock_dcache_all()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: up_coherent_dcache
|
|
*
|
|
* Description:
|
|
* Ensure that the I and D caches are coherent within specified region
|
|
* by cleaning the D cache (i.e., flushing the D cache contents to memory
|
|
* and invalidating the I cache. This is typically used when code has been
|
|
* written to a memory region, and will be executed.
|
|
*
|
|
* Input Parameters:
|
|
* addr - virtual start address of region
|
|
* len - Size of the address region in bytes
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_ICACHE
|
|
void up_coherent_dcache(uintptr_t addr, size_t len);
|
|
#else
|
|
# define up_coherent_dcache(addr, len)
|
|
#endif
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __ASSEMBLY__ */
|
|
|
|
#endif /* __INCLUDE_NUTTX_CACHE_H */
|