cache.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Carlo Caione <ccaione@baylibre.com>
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_ARCH_CACHE_H_
#define ZEPHYR_INCLUDE_ARCH_CACHE_H_

 
#if defined(CONFIG_ARM64)
#include <zephyr/arch/arm64/cache.h>
#elif defined(CONFIG_XTENSA)
#include <zephyr/arch/xtensa/cache.h>
#endif
 
#include <stddef.h>
#include <stdbool.h>
 
#if defined(CONFIG_DCACHE) || defined(__DOXYGEN__)

void arch_dcache_enable(void);
 
#define cache_data_enable arch_dcache_enable

void arch_dcache_disable(void);
 
#define cache_data_disable arch_dcache_disable

int arch_dcache_flush_all(void);
 
#define cache_data_flush_all arch_dcache_flush_all

int arch_dcache_invd_all(void);
 
#define cache_data_invd_all arch_dcache_invd_all

int arch_dcache_flush_and_invd_all(void);
 
#define cache_data_flush_and_invd_all arch_dcache_flush_and_invd_all

int arch_dcache_flush_range(void *addr, size_t size);
 
#define cache_data_flush_range(addr, size) arch_dcache_flush_range(addr, size)

int arch_dcache_invd_range(void *addr, size_t size);
 
#define cache_data_invd_range(addr, size) arch_dcache_invd_range(addr, size)

 
int arch_dcache_flush_and_invd_range(void *addr, size_t size);
 
#define cache_data_flush_and_invd_range(addr, size) \
        arch_dcache_flush_and_invd_range(addr, size)
 
#if defined(CONFIG_DCACHE_LINE_SIZE_DETECT) || defined(__DOXYGEN__)

size_t arch_dcache_line_size_get(void);
 
#define cache_data_line_size_get arch_dcache_line_size_get
 
#endif /* CONFIG_DCACHE_LINE_SIZE_DETECT || __DOXYGEN__ */
 
#endif /* CONFIG_DCACHE || __DOXYGEN__ */
 
#if defined(CONFIG_ICACHE) || defined(__DOXYGEN__)

void arch_icache_enable(void);
 
#define cache_instr_enable arch_icache_enable

void arch_icache_disable(void);
 
#define cache_instr_disable arch_icache_disable

int arch_icache_flush_all(void);
 
#define cache_instr_flush_all arch_icache_flush_all

int arch_icache_invd_all(void);
 
#define cache_instr_invd_all arch_icache_invd_all

int arch_icache_flush_and_invd_all(void);
 
#define cache_instr_flush_and_invd_all arch_icache_flush_and_invd_all

int arch_icache_flush_range(void *addr, size_t size);
 
#define cache_instr_flush_range(addr, size) arch_icache_flush_range(addr, size)

int arch_icache_invd_range(void *addr, size_t size);
 
#define cache_instr_invd_range(addr, size) arch_icache_invd_range(addr, size)

int arch_icache_flush_and_invd_range(void *addr, size_t size);
 
#define cache_instr_flush_and_invd_range(addr, size) \
        arch_icache_flush_and_invd_range(addr, size)
 
#if defined(CONFIG_ICACHE_LINE_SIZE_DETECT) || defined(__DOXYGEN__)

 
size_t arch_icache_line_size_get(void);
 
#define cache_instr_line_size_get arch_icache_line_size_get
 
#endif /* CONFIG_ICACHE_LINE_SIZE_DETECT || __DOXYGEN__ */
 
#endif /* CONFIG_ICACHE || __DOXYGEN__ */
 
#if CONFIG_CACHE_DOUBLEMAP  || __DOXYGEN__
bool arch_cache_is_ptr_cached(void *ptr);
#define cache_is_ptr_cached(ptr) arch_cache_is_ptr_cached(ptr)
 
bool arch_cache_is_ptr_uncached(void *ptr);
#define cache_is_ptr_uncached(ptr) arch_cache_is_ptr_uncached(ptr)
 
void __sparse_cache *arch_cache_cached_ptr_get(void *ptr);
#define cache_cached_ptr(ptr) arch_cache_cached_ptr_get(ptr)
 
void *arch_cache_uncached_ptr_get(void __sparse_cache *ptr);
#define cache_uncached_ptr(ptr) arch_cache_uncached_ptr_get(ptr)
#endif /* CONFIG_CACHE_DOUBLEMAP */
 
 
void arch_cache_init(void);

 
#endif /* ZEPHYR_INCLUDE_ARCH_CACHE_H_ */