FreeRTOS+FAT: DOS Compatible Embedded FAT File System

FreeRTOS+FAT is an open source, thread aware and scalable FAT12/FAT16/FAT32 DOS /Windows compatible embedded FAT file system which was recently acquired by Real Time Engineers ltd. for use with and without FreeRTOS.

FreeRTOS+FAT is already used in commercial products, and is the file system used in the FTP and HTTP server examples that are documented on the FreeRTOS+TCP pages.

The standard C library style API includes a thread local errno value, and the lower level native API provides a rich set of detailed error codes.

For more details, please visit FreeRTOS+FAT page.

To consume FreeRTOS+FAT

Consume with CMake

If using CMake, it is recommended to use this repository using FetchContent. Add the following into your project's main or a subdirectory's CMakeLists.txt:

include(FetchContent)

FetchContent_Declare( freertos_plus_fat
  GIT_REPOSITORY "https://github.com/FreeRTOS/Lab-Project-FreeRTOS-FAT.git"
  GIT_TAG        main #Note: Best practice to use specific git-hash or tagged version
  GIT_SUBMODULES "" # Don't grab any submodules since not latest
)

# ...

set( FREERTOS_PLUS_FAT_DEV_SUPPORT OFF CACHE BOOL "" FORCE)
# Select the native compile PORT
set( FREERTOS_PLUS_FAT_PORT "POSIX" CACHE STRING "" FORCE)
# Select the cross-compile PORT
if (CMAKE_CROSSCOMPILING)
  # Eg. Zynq 2019_3 version of port
  set(FREERTOS_PLUS_FAT_PORT "ZYNQ_2019_3" CACHE STRING "" FORCE)
endif()

FetchContent_MakeAvailable(freertos_plus_fat)

If you already have FreeRTOS in your project, you may skip the fetch content by setting FREERTOS_PLUS_FAT_FETCH_FREERTOS to OFF.

Consuming stand-alone

It is recommended to use this repository as a submodule. Please refer to Git Tools — Submodules.

Running the unit tests

Host-based unit tests live in test/unit-test and are built with Unity and CMock.

Prerequisites: CMake, a C compiler, make, Ruby (used by CMock and the Unity test-runner generator), and lcov for coverage.

The tests rely on the CMock submodule. Initialise submodules first (the build will also attempt to clone it automatically if missing):

git submodule update --init --recursive

Configure, build, and run the tests:

cmake -S test/unit-test -B test/unit-test/build/
make -C test/unit-test/build/ all
ctest --test-dir test/unit-test/build/ -E system --output-on-failure

Optionally generate a coverage report (writes coverage.info):

make -C test/unit-test/build/ coverage
lcov --list --rc branch_coverage=1 test/unit-test/build/coverage.info

See test/unit-test/README.md for details on the test layout and how to add new tests.

Notes

This project is undergoing optimizations or refactoring to improve memory usage, modularity, documentation, demo usability, or test coverage.