refactor(spi_nand_flash_fatfs): separate fatfs integration from spi_nand_flash into new component

Author: RathiSonika

.build-test-rules.yml

@@ -94,3 +94,8 @@ spi_nand_flash/host_test:
       reason: The spi_nand_flash component is compatible with IDF version v5.0 and above, due to a change in the f_mkfs API in versions above v5.0, which is not supported in older IDF versions.
     - if: IDF_VERSION_MAJOR == 5 and (IDF_VERSION_MINOR < 3)
       reason: Fails to build on older versions of IDF
+
+spi_nand_flash_fatfs/examples/nand_flash:
+  disable:
+    - if: IDF_VERSION_MAJOR < 5
+      reason: The spi_nand_flash component is compatible with IDF version v5.0 and above, due to a change in the f_mkfs API in versions above v5.0, which is not supported in older IDF versions.

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -64,6 +64,7 @@ body:
         - quirc
         - sh2lib
         - spi_nand_flash
+        - spi_nand_flash_fatfs
         - supertinycron
         - thorvg
         - touch_element

.github/workflows/upload_component.yml

@@ -66,6 +66,7 @@ jobs:
             quirc
             sh2lib
             spi_nand_flash
+            spi_nand_flash_fatfs
             supertinycron
             thorvg
             touch_element

spi_nand_flash_fatfs/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [1.0.0]
+
+### Breaking Changes
+- FATFS integration for SPI NAND Flash now lives in this component. Projects that previously relied on FATFS support bundled inside `spi_nand_flash` must add `spi_nand_flash_fatfs` as a dependency and include its headers.
+
+**Migration:** See **Migration Guide (0.x → 1.0.0)** in [`spi_nand_flash/layered_architecture.md`](../spi_nand_flash/layered_architecture.md) (FATFS split, legacy init with BDL disabled, and related driver changes).

spi_nand_flash_fatfs/CMakeLists.txt

@@ -0,0 +1,9 @@
+set(srcs "src/diskio_nand.c"
+         "src/vfs_fat_spinandflash.c")
+
+idf_component_register(
+    SRCS ${srcs}
+    INCLUDE_DIRS "include"
+    REQUIRES spi_nand_flash fatfs
+    PRIV_REQUIRES vfs
+)

spi_nand_flash_fatfs/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

spi_nand_flash_fatfs/README.md

@@ -0,0 +1,58 @@
+# SPI NAND Flash FatFS Integration
+
+FatFS integration layer for the SPI NAND Flash driver.
+
+## Requirements (read first)
+
+**`spi_nand_flash_fatfs` only supports the legacy driver handle** (`spi_nand_flash_device_t` from `spi_nand_flash_init_device()`).
+
+- Keep **`CONFIG_NAND_FLASH_ENABLE_BDL` disabled** in menuconfig. When BDL is enabled, `spi_nand_flash_init_device()` returns `ESP_ERR_NOT_SUPPORTED`, so `esp_vfs_fat_nand_mount()` / diskio cannot be used.
+- **FatFs on top of the wear-leveling block device (`esp_blockdev_t`) is not supported in this release.** A future component integration will add it; until then use the legacy path above for FAT.
+
+**Migration from 0.x:** See the SPI NAND component’s [layered_architecture.md](../spi_nand_flash/layered_architecture.md) — **Migration Guide (0.x → 1.0.0)** (FATFS split, BDL vs legacy init).
+
+## Features
+
+- FATFS diskio adapter and VFS mount helpers using `spi_nand_flash_device_t`
+- Same usage as before the `spi_nand_flash` / `spi_nand_flash_fatfs` split (legacy init + mount)
+
+## Dependencies
+
+- `spi_nand_flash` component (driver)
+- ESP-IDF `fatfs` component
+- ESP-IDF `vfs` component
+
+## Usage
+
+```c
+#include "spi_nand_flash.h"
+#include "esp_vfs_fat_nand.h"
+
+// Initialize device (CONFIG_NAND_FLASH_ENABLE_BDL must be off)
+spi_nand_flash_device_t *nand_device;
+spi_nand_flash_init_device(&config, &nand_device);
+
+// Mount FATFS
+esp_vfs_fat_mount_config_t mount_config = {
+    .max_files = 4,
+    .format_if_mount_failed = true,
+};
+esp_vfs_fat_nand_mount("/nand", nand_device, &mount_config);
+
+// Use filesystem...
+FILE *f = fopen("/nand/test.txt", "w");
+// ...
+
+// Unmount
+esp_vfs_fat_nand_unmount("/nand", nand_device);
+spi_nand_flash_deinit_device(nand_device);
+```
+
+## Examples
+
+| Example | Description | `CONFIG_NAND_FLASH_ENABLE_BDL` | IDF |
+|---------|-------------|--------------------------------|-----|
+| `examples/nand_flash` | FATFS on NAND (`spi_nand_flash_init_device` + `esp_vfs_fat_nand_mount`) | **Must be off** | 5.0+ |
+| `examples/nand_flash_debug_app` | Diagnostics (bad blocks, ECC stats, throughput); `spi_nand_flash` only, no VFS | **Must be off** | 5.0+ |
+
+See each example’s `README.md` for hardware and usage.

spi_nand_flash_fatfs/examples/nand_flash/CMakeLists.txt

@@ -0,0 +1,8 @@
+# The following lines of boilerplate have to be in your project's CMakeLists
+# in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.5)
+
+set(COMPONENTS main)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(nand_flash)

spi_nand_flash_fatfs/examples/nand_flash/README.md

@@ -0,0 +1,77 @@
+| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
+| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
+
+# SPI NAND Flash Example
+
+This example demonstrates how to use the SPI NAND Flash driver with FAT filesystem in ESP-IDF.
+
+## Hardware Required
+
+* Any ESP board from the supported targets list above
+* An external SPI NAND Flash chip connected to the following pins:
+  * For ESP32 (SPI3):
+    - MOSI - SPI3_IOMUX_PIN_NUM_MOSI (23)
+    - MISO - SPI3_IOMUX_PIN_NUM_MISO (19)
+    - CLK  - SPI3_IOMUX_PIN_NUM_CLK (18)
+    - CS   - SPI3_IOMUX_PIN_NUM_CS (5)
+    - WP   - SPI3_IOMUX_PIN_NUM_WP (22)
+    - HD   - SPI3_IOMUX_PIN_NUM_HD (21)
+  * For other ESP chips (SPI2):
+    - MOSI - SPI2_IOMUX_PIN_NUM_MOSI (13)
+    - MISO - SPI2_IOMUX_PIN_NUM_MISO (12)
+    - CLK  - SPI2_IOMUX_PIN_NUM_CLK (14)
+    - CS   - SPI2_IOMUX_PIN_NUM_CS (15)
+    - WP   - SPI2_IOMUX_PIN_NUM_WP (2)
+    - HD   - SPI2_IOMUX_PIN_NUM_HD (4)
+
+## Configuration
+
+The example can be configured to format the filesystem if mounting fails. This can be enabled using the `CONFIG_EXAMPLE_FORMAT_IF_MOUNT_FAILED` configuration option.
+
+Keep **`CONFIG_NAND_FLASH_ENABLE_BDL` disabled** (Component config → SPI NAND Flash). This example uses `spi_nand_flash_init_device()`, which is not available when BDL is enabled.
+
+## How to Use Example
+
+Build the project and flash it to the board, then run monitor tool to view serial output:
+
+```bash
+idf.py -p PORT flash monitor
+```
+
+(To exit the serial monitor, type ``Ctrl-]``.)
+
+See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.
+
+## Example Output
+
+The example:
+1. Initializes the SPI bus and NAND Flash device
+2. Mounts a FAT filesystem on the NAND Flash
+3. Creates and writes to a file named "hello.txt"
+4. Reads back and displays the contents of the file
+5. Displays filesystem space information
+6. Unmounts the filesystem and deinitializes the NAND Flash
+
+Here is the example's console output:
+```
+...
+I (315) main_task: Calling app_main()
+I (315) example: DMA CHANNEL: 3
+W (355) vfs_fat_nand: f_mount failed (13)
+I (355) vfs_fat_nand: Formatting FATFS partition, allocation unit size=16384
+I (6635) vfs_fat_nand: Mounting again
+I (6655) example: FAT FS: 117024 kB total, 117024 kB free
+I (6655) example: Opening file
+I (6685) example: File written
+I (6685) example: Reading file
+I (6685) example: Read from file: 'Written using ESP-IDF v5.5-dev-2627-g2cbfce97768'
+I (6685) example: FAT FS: 117024 kB total, 117008 kB free
+I (6695) gpio: GPIO[5]| InputEn: 0| OutputEn: 0| OpenDrain: 0| Pullup: 1| Pulldown: 0| Intr:0
+I (6705) gpio: GPIO[23]| InputEn: 0| OutputEn: 0| OpenDrain: 0| Pullup: 1| Pulldown: 0| Intr:0
+I (6705) gpio: GPIO[19]| InputEn: 0| OutputEn: 0| OpenDrain: 0| Pullup: 1| Pulldown: 0| Intr:0
+I (6715) gpio: GPIO[18]| InputEn: 0| OutputEn: 0| OpenDrain: 0| Pullup: 1| Pulldown: 0| Intr:0
+I (6725) gpio: GPIO[22]| InputEn: 0| OutputEn: 0| OpenDrain: 0| Pullup: 1| Pulldown: 0| Intr:0
+I (6735) gpio: GPIO[21]| InputEn: 0| OutputEn: 0| OpenDrain: 0| Pullup: 1| Pulldown: 0| Intr:0
+I (6745) main_task: Returned from app_main()
+...
+```

spi_nand_flash_fatfs/examples/nand_flash/main/CMakeLists.txt

@@ -0,0 +1,4 @@
+idf_component_register(SRCS "spi_nand_flash_example_main.c"
+                       INCLUDE_DIRS "."
+                       PRIV_REQUIRES spi_nand_flash_fatfs
+                       )