zephyr

History

Johann Fischer 5c7787c912 doc: update disk access docu regarding SD card support This patch removes sdhc_api references since such API does not actually exist. SD card controller drivers use disc driver interface. Accordingly, the SDHC documentation, which actually describes how to connect a SD card via SPI and has little to do with SD host controller (SDHC), is also moved to disk access page and adapted. Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>		2021-03-23 12:16:01 +01:00
..
boards	tests/boards/samples: fixup after sdmmc driver relocation	2021-03-23 12:16:01 +01:00
src	include: move disk_access.h to storage	2021-03-23 12:16:01 +01:00
CMakeLists.txt	samples: make find_package(Zephyr...) REQUIRED	2020-05-29 10:47:25 +02:00
prj.conf	samples: subsys: fs: Refactor fat_fs board configurations	2020-05-07 14:47:43 +02:00
README.rst	doc: update disk access docu regarding SD card support	2021-03-23 12:16:01 +01:00
sample.yaml	samples: subsys: Add sdhc fixture to fat_fs sample	2020-09-18 14:39:46 -05:00

README.rst

.. _fat_fs:

FAT Filesystem Sample Application
###################################

Overview
********

This sample app demonstrates use of the filesystem API and uses the FAT file
system driver to mount an SDHC card connected over a SPI bus or to an on-chip
SDHC controller.

Requirements
************

This project requires SD card support and microSD card formatted with FAT filesystem.
See the :ref:`disk_access_api` documentation for Zephyr implementation details.

Building and Running
********************

This sample can be built for a variety of boards, including ``nrf52840_blip``,
``mimxrt1050_evk``, and ``olimexino_stm32``.

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/fs/fat_fs
   :board: nrf52840_blip
   :goals: build
   :compact:

To run this sample, a FAT formatted microSD card should be present in the
microSD slot. If there are any files or directories present in the card, the
sample lists them out on the debug serial output.