Listing files on Micro SD card connected to Arduino Nano using FatFs
| |
| Developer(s) | ChaN |
|---|---|
| Initial release | February 26, 2006; 18 years ago (2006-02-26) |
| Stable release | R0.15 / 2022 |
| Repository | Releases archive |
| Written in | ANSI C |
| Platform | Intel 8051, PIC, AVR, ARM, Z80 |
| Type | Embedded systems software |
| License | Own license, similar to BSD |
| Website | elm-chan.org |
FatFs is a lightweight software library for microcontrollers and embedded systems that implements FAT/exFAT file system support.[1] Written on pure ANSI C, FatFs is platform-independent and easy to port on many hardware platforms such as 8051, PIC, AVR, ARM, Z80. FatFs is designed as thread-safe and is built into ChibiOS, RT-Thread, ErlendOS,[2] and Zephyr real-time operating systems.[3]
Most often, FatFs is used in low-power Embedded systems where memory is limited, since the library takes up little space in RAM and program code. In the minimum version, the working code takes from 2 to 10 kB of RAM.[4]
FatFs is designed to be a Filesystem Layer that is agnostic to the platform and storage media it is used with. This is achieved by providing a media access interface that is used to communicate with the storage device control module which is provided by the implementer.[5] This means that FatFs can work with any physical device such as an SD card or a hard disk on any platform that can run plain C code if the implementer provides a control module interface.
FatFs library architecture logically separates the abstractions of the user app and the platform-dependent code. The user application and the low level disk I/O layer (driver) must be added by the implementer.[5]: 11 Also, the architecture of the library implies that the system can have several storage devices with different drivers and the library can work in a multi-threaded operating system. At the application level it is hidden which physical media is used.
In the minimum implementation, the driver layer must support at least these 3 interfaces:[5]: 14
disk_status — return block device status (not initialized, missing, protected, ready)disk_initialize — initialize the physical diskdisk_read — read block from physical diskThis level of abstraction allows implementers to write an application once, and then port it on different platforms, changing only the implementation of the driver.[6]
FatFs has its own minimalistic license [7] similar to the BSD license. It allows usage in commercial products without disclosing the source code.[5]: 12 The only condition is to keep the copyright notice in case of redistribution of the source code. The conditions of FatFs license are not cover any redistributions in binary form, such as embedded code and hex files.
