summaryrefslogtreecommitdiff
path: root/lib/fatfs/test_apps/README.md
diff options
context:
space:
mode:
authorjacqueline <me@jacqueline.id.au>2023-07-25 17:42:00 +1000
committerjacqueline <me@jacqueline.id.au>2023-07-25 17:42:00 +1000
commit7b72e5479ee6d11f76c49f7463ba0e7f4e5165c5 (patch)
tree2965c66cf3973583b7751b771f9bc06232d98222 /lib/fatfs/test_apps/README.md
parent9287c4eb8c60cc89251a1d2bdfe9c576d81d6715 (diff)
downloadtangara-fw-7b72e5479ee6d11f76c49f7463ba0e7f4e5165c5.tar.gz
fork the esp-idf fatfs for f_forward and exfat support
Diffstat (limited to 'lib/fatfs/test_apps/README.md')
-rw-r--r--lib/fatfs/test_apps/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/lib/fatfs/test_apps/README.md b/lib/fatfs/test_apps/README.md
new file mode 100644
index 00000000..2140e8c4
--- /dev/null
+++ b/lib/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/).