From 6a86614d74ef3144f9fd7dd65bdbb7ad8cc43936 Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Mon, 10 Oct 2022 12:15:56 +0200 Subject: [PATCH] fatfs: add missing readme file for the test apps --- components/fatfs/test_apps/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 components/fatfs/test_apps/README.md diff --git a/components/fatfs/test_apps/README.md b/components/fatfs/test_apps/README.md new file mode 100644 index 0000000000..2140e8c4fe --- /dev/null +++ b/components/fatfs/test_apps/README.md @@ -0,0 +1,19 @@ +# fatfs component target tests + +This directory contains tests for `fatfs` component which are run on chip targets. + +See also [test_fatfs_host](../test_fatfs_host) directory for the tests which run on a Linux host. + +Fatfs tests can be executed with different `diskio` backends: `diskio_sdmmc` (SD cards over SD or SPI interface), `diskio_spiflash` (wear levelling in internal flash) and `diskio_rawflash` (read-only, no wear levelling, internal flash). There is one test app here for each of these backends: + +- [sdcard](sdcard/) — runs fatfs tests with an SD card over SDMMC or SDSPI interface +- [flash_wl](flash_wl/) - runs fatfs test in a wear_levelling partition in SPI flash +- [flash_ro](flash_ro/) - runs fatfs test in a read-only (no wear levelling) partition in SPI flash + +These test apps define: +- test functions +- setup/teardown routines +- build/test configurations +- pytest test runners + +The actual test cases (many of which are common between the test apps) are defined in the [test_fatfs_common component](test_fatfs_common/).