L2 cache library

Features

The L2 cache component uses the XS3 swmem feature to handle reads from external flash. It has the advantage of read caching using on-chip RAM for additional performance and provides memory mapped access.

Software version and dependencies

The CHANGELOG contains information about the current and previous versions. For a list of direct dependencies, look for DEPENDENT_MODULES in lib_random/module_build_info.

Install XCore SDK

See: https://github.com/xmos/xcore_sdk/blob/develop/documents/quick_start/installation.rst

Building and running the firmware

Make a directory for the build.

$ mkdir build
$ cd build

To configure and build the firmware, run:

$ cmake ../
$ make -j

To flash the SwMem section, run:

$ make flash

To run the firmware with hardware, run:

$ make run

Useful Build Configurations

The L2 cache has a debug mode which will track and printout some useful metrics, like hit rate. Note that this mode will make the timing metrics unreliable so those are not printed. To configure and build with the L2 cache in debug mode, run:

$ cmake ../ -DL2_CACHE_DEBUG=1
$ make -j

The flash handler has a debug mode which will track and printout some useful metrics, like the number of flash reads and throughput. To configure and build with the flash handler in debug mode, run:

$ cmake ../ -DFLASH_DEBUG=1
$ make -j

To configure and build the firmware, placing all benchmark code and data in SRAM, run:

$ cmake ../ -DUSE_SWMEM=0
$ make -j