summaryrefslogtreecommitdiff
path: root/lib/fatfs/test_apps/flash_ro/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/flash_ro/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/flash_ro/README.md')
-rw-r--r--lib/fatfs/test_apps/flash_ro/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/lib/fatfs/test_apps/flash_ro/README.md b/lib/fatfs/test_apps/flash_ro/README.md
new file mode 100644
index 00000000..2dcdd216
--- /dev/null
+++ b/lib/fatfs/test_apps/flash_ro/README.md
@@ -0,0 +1,14 @@
+| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
+| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
+
+This test app runs a few FATFS test cases in a read-only FAT partition.
+
+These tests should be possible to run on any ESP development board, not extra hardware is necessary.
+
+The initial FAT image is generated during the build process in [main/CMakeLists.txt](main/CMakeLists.txt):
+- `create_test_files` function creates a set of files expected by the test cases
+- `fatfs_create_rawflash_image` generates a FAT image from the set of files (via `fatfsgen.py`)
+
+The generated FAT image is flashed into `storage` partition when running `idf.py flash`.
+
+See [../README.md](../README.md) for more information about FATFS test apps.