FatFs - Generic FAT Filesystem Module

FatFs is a generic FAT/exFAT filesystem module for small embedded systems.

---

Table of Contents

• Features
• Configuration Options
• Application Interface
  • File Access
  • Directory Access
  • File & Directory Management
• Notes
• Summary

---

Features

• DOS/Windows-compatible FAT/exFAT filesystem
• Very small code footprint and RAM usage

---

Configuration Options

• Long File Name (LFN) support (ANSI/OEM or Unicode)
• exFAT filesystem support
• 64-bit LBA and GPT support for large storage
• Thread-safe operation for RTOS environments
• Multiple volumes (drives and partitions)
• Variable sector sizes
• Multiple code pages (including DBCS)
• Optional APIs and read-only configurations

---

Application Interface

File Access

• f_open – Open or create a file
• f_close – Close a file
• f_read – Read data from a file
• f_write – Write data to a file
• f_lseek – Move the read/write pointer
• f_truncate – Truncate file size
• f_sync – Flush cached data
• f_forward – Forward data to a stream
• f_expand – Allocate contiguous space
• f_gets – Read a string
• f_putc – Write a character
• f_puts – Write a string
• f_printf – Write formatted text
• f_tell – Get current file offset
• f_eof – Check for end-of-file
• f_size – Get file size
• f_error – Check error status

---

Directory Access

• f_opendir – Open a directory
• f_closedir – Close a directory
• f_readdir – Read directory entries
• f_findfirst – Find first matching entry
• f_findnext – Find next matching entry

---

File & Directory Management

• f_stat – Check existence/status
• f_unlink – Delete file or directory
• f_mkdir – Create directory
• f_rename – Rename or move

---

Notes

• Designed for resource-constrained embedded systems
• Filesystem layer is separated from hardware-specific drivers tem for embedded systems.

---

Read-only copy of (https://elm-chan.org/fsw/ff)