@page fatfs

[更正文档](https://gitee.com/alios-things/fatfs/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)

# 概述
**fatfs** is a generic FAT/exFAT filesystem module for small embedded system. The fatfs module is written in compliance with ANSI C (C89). It attempts to provide AOS-compatible filesystem behaviour.
组件支持以下功能
- DOS/Windows compatible FAT/exFAT filesystem
- Very small footprint for program code and work area
- Various configuration options to support for:
    - Long file name in ANSI/OEM or Unicode.
    - exFAT filesystem.
    - Thread safe for RTOS.
    - Multiple volumes (physical drives and partitions)
    - Variable sector size.
    - Multiple code page including DBCS.
    - Read-only, optional API, I/O buffer and etc...

## 版权信息
> Apache license v2.0

## 目录结构
```tree
fatfs
├── src
│   ├── mmc_disk
│   │   ├── mmc_disk.c
│   │   └── mmc_disk.h
│   ├── ram_disk
│   │   ├── ram_disk.c
│   │   └── ram_disk.h
│   ├── sd_disk
│   │   ├── sd_disk.c
│   │   └── sd_disk.h
│   └── usb_disk
│       ├── usb_disk.c
│       └── usb_disk.h
├── include
│   ├── diskio.h
│   ├── fatfs_diskio.h
│   ├── fatfs.h
│   ├── ff.h
│   ├── ffconf.h
│   ├── integer.h
├── package.yaml     # 编译配置文件
├── example
│    └── fatfs_example.c # 示例代码
└─── README.md
```

## 依赖组件
* rhino
* vfs

# 常用配置

```yaml
def_config:
  CONFIG_AOS_FATFS_SUPPORT_MMC: 1
  AOS_COMP_VFS: 1
  AOS_COMP_FATFS: 1
```

# 使用示例

组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
待开发环境搭建完成后，可以按照以下步骤进行示例的测试。

## 步骤1 创建或打开工程

**打开已有工程**

如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。

**创建新的工程**

组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。

## 步骤2 添加组件

案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：

```yaml

depends:
  - fatfs: master # helloworld_demo中引入fatfs组件

```

## 步骤3 下载组件

在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：

```shell

aos install fatfs

```

上述命令执行成功后，组件源码则被下载到了./components/fatfs路径中。

## 步骤4 添加示例

在fatfs组件的package.yaml中添加[example示例代码](https://gitee.com/alios-things/a2sa/tree/master/example)：
示例代码参考example/fatfs_example.c。

```yaml
source_file:
  - "src/*.c"
  - "example/fatfs_example.c" # add fatfs_example.c
```

## 步骤5 编译固件

在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。

## 步骤6 烧录固件

helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。

## 步骤7 打开串口

固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。

当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。

## 步骤8 测试示例

> CLI命令行输入：
```sh
fatfs_example
```

**关键日志**
> CLI日志：
```sh
fatfs component example start!
aos_open fd1=xxx
aos_write num=xxx
aos_open fd2=xxx
aos_lseek position=xxx
aos_read: xxxx
fatfs component example end !
```