Cache Control Configuration

This is a high-level guide to Zephyr’s cache interface and Kconfig options related to cache controllers. See Cache API for API reference material.

Zephyr has different Kconfig options to control how the cache controller is implemented and controlled.

  • CONFIG_CPU_HAS_DCACHE / CONFIG_CPU_HAS_ICACHE: these hidden options should be selected at SoC / platform level when the CPU actually supports a data or instruction cache. The cache controller can be in the core or can be an external cache controller for which a driver is provided.

    These options have the goal to document an available hardware feature and should be set whether we plan to support and use the cache control in Zephyr or not.

  • CONFIG_DCACHE / CONFIG_ICACHE: these options must be selected when support for data or instruction cache is present and working in zephyr. Note that if these options are disabled, caching may still be enabled depending on the hardware defaults.

    All the code paths related to cache control must be conditionally enabled depending on these symbols. When the symbol is set the cache is considered enabled and used.

    These symbols say nothing about the actual API interface exposed to the user. For example a platform using the data cache can enable the CONFIG_DCACHE symbol and use some HAL exported function in some platform-specific code to enable and manage the d-cache.

  • CONFIG_CACHE_MANAGEMENT: this option must be selected when the cache operations are exposed to the user through a standard API (see Cache API).

    When this option is enabled we assume that all the cache functions are implemented in the architectural code or in an external cache controller driver.

  • CONFIG_MEM_ATTR: this option allows the user to specify (using memory region attributes) a fixed region in memory that will have caching disabled once the kernel has initialized.

  • CONFIG_NOCACHE_MEMORY: this option allows the user to specify individual global variables as uncached using __nocache. This will instruct the linker to place any marked variables into a special nocache region in memory and the MPU driver will configure that region as uncached.

  • CONFIG_ARCH_CACHE/CONFIG_EXTERNAL_CACHE: mutually exclusive options for CACHE_TYPE used to define whether the cache operations are implemented at arch level or using an external cache controller with a provided driver.

    • CONFIG_ARCH_CACHE: the cache API is implemented by the arch code

    • CONFIG_EXTERNAL_CACHE: the cache API is implemented by a driver that supports the external cache controller. In this case the driver must be located as usual in the drivers/cache/ directory

Cache API

Cache Interface