initial filesystem samples package

.gitignore

@@ -0,0 +1,52 @@
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+*.pdb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf

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.
+

README.md

@@ -1,2 +1,79 @@
-# filesystem-sample
-RT-Thread filesystem samples
+# filesystem samples package
+
+## 1、介绍
+
+这个软件包包含了文件系统使用的相关示例代码。
+
+### 1.1 目录结构
+
+| 目录          | 例程                   |
+| ------------- | ---------------------- |
+| openfile      | 打开文件               |
+| readwrite     | 文件读写               |
+| rename        | 更改名称               |
+| stat          | 取得状态               |
+| mkdir         | 创建目录               |
+| opendir       | 打开目录               |
+| readdir       | 读取目录               |
+| tell_seek_dir | 保存与设置读取目录位置 |
+
+### 1.2 许可证
+
+filesystem samples package 遵循 Apache license v2.0 许可，详见 `LICENSE` 文件。
+
+### 1.3 依赖
+
+使用 filesystem samples package 需要在 RT-Thread 的 menuconfig 配置选项中使能文件系统相关功能，具体路径如下：
+
+```
+RT-Thread Components
+    device virtual file system --->
+
+```
+
+## 2、如何打开 filesystem samples package
+
+使用 filesystem samples package 需要在 RT-Thread 的包管理器中选择它，具体路径如下：
+
+```
+RT-Thread online packages
+    miscellaneous packages --->
+        samples: kernel and components samples --->
+            a filesystem_samples package for rt-thread --->
+
+```
+
+然后让 RT-Thread 的包管理器自动更新，或者使用 `pkgs --update` 命令更新包到 BSP 中。
+
+## 3、使用 filesystem samples package
+
+在打开 filesystem samples package 后，当进行 BSP 编译时，选择的软件包相关源代码会被加入到 BSP 工程中进行编译。
+
+** API 列表 **
+
+| API                                                   | 功能                     |
+| ----------------------------------------------------- | ------------------------ |
+| int open(const char *pathname, int oflag, int mode);  | 打开文件                 |
+| int close(int fd);                                    | 关闭文件                 |
+| size_t read(int fd, void *buf, size_t count);         | 读取数据                 |
+| size_t write(int fd, const void *buf, size_t count);  | 写入数据                 |
+| int rename(const char *oldpath, const char *newpath); | 更改名称                 |
+| int stat(const char *file_name, struct stat *buf);    | 取得状态                 |
+| int mkdir(const char *path, mode_t mode);             | 创建目录                 |
+| DIR* opendir(const char* name);                       | 打开目录                 |
+| struct dirent* readdir(DIR *d);                       | 读取目录                 |
+| off_t telldir(DIR *d);                                | 取得目录流的读取位置     |
+| void seekdir(DIR *d, off_t offset);                   | 设置读取目录的位置       |
+| void rewinddir(DIR *d);                               | 重设读取目录的位置到开头 |
+| int closedir(DIR* d);                                 | 关闭目录                 |
+| int rmdir(const char *pathname);                      | 删除目录                 |
+| int mkfs(const char * fs_name, const char * device)   | 格式化文件系统           |
+
+## 4、注意事项
+
+暂无。
+
+## 5、联系方式 & 感谢
+
+* 维护：name
+* 主页：https://github.com/RT-Thread-packages/filesystem-sample.git

SConscript

@@ -0,0 +1,44 @@
+from building import *
+Import('rtconfig')
+
+src   = []
+cwd   = GetCurrentDir()
+group = []
+CPPPATH = []
+
+# add filesystem samples.
+if GetDepend('FILESYSTEM_SAMPLES_USING_OPENFILE'):
+    src += ['openfile/openfile.c']
+    CPPPATH += [cwd + '/openfile']
+
+if GetDepend('FILESYSTEM_SAMPLES_USING_READWRITE'):
+    src += ['readwrite/readwrite.c']
+    CPPPATH += [cwd + '/readwrite']
+
+if GetDepend('FILESYSTEM_SAMPLES_USING_STAT'):
+    src += ['stat/stat.c']
+    CPPPATH += [cwd + '/stat']
+
+if GetDepend('FILESYSTEM_SAMPLES_USING_RENAME'):
+    src += ['rename/rename.c']
+    CPPPATH += [cwd + '/rename']
+
+if GetDepend('FILESYSTEM_SAMPLES_USING_MKDIR'):
+    src += ['mkdir/mkdir.c']
+    CPPPATH += [cwd + '/mkdir']
+
+if GetDepend('FILESYSTEM_SAMPLES_USING_OPENDIR'):
+    src += ['opendir/opendir.c']
+    CPPPATH += [cwd + '/opendir']
+
+if GetDepend('FILESYSTEM_SAMPLES_USING_READDIR'):
+    src += ['readdir/readdir.c']
+    CPPPATH += [cwd + '/readdir']
+
+if GetDepend('FILESYSTEM_SAMPLES_USING_TELL_SEEK_DIR'):
+    src += ['tell_seek_dir/tell_seek_dir.c']
+    CPPPATH += [cwd + '/tell_seek_dir']
+
+group = DefineGroup('filesystem-samples', src, depend = ['PKG_USING_FILESYSTEM_SAMPLES'], CPPPATH = CPPPATH)
+
+Return('group')

mkdir/README.md

@@ -0,0 +1,52 @@
+# 创建目录 #
+
+## 介绍 ##
+
+这个例程展示了如何创建目录。
+
+## 程序清单 ##
+
+```{.c}
+/*
+ * 程序清单：创建目录
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 mkdir() 函数
+ * int mkdir(const char *path, mode_t mode);
+ * mkdir()函数用来创建一个目录，参数path 为目录名，
+ * 参数mode 在当前版本未启用，输入0x777 即可。
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+static void mkdir_sample(void)
+{
+    int ret;
+
+    /* 创建目录*/
+    ret = mkdir("/dir_test", 0x777);
+    if (ret < 0)
+    {
+        /* 创建目录失败*/
+        rt_kprintf("dir error!\n");
+    }
+    else
+    {
+        /* 创建目录成功*/
+        rt_kprintf("mkdir ok!\n");
+    }
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(mkdir_sample, mkdir sample);
+```
+
+## 运行结果 ##
+
+```
+msh />mkdir_sample
+mkdir ok!
+msh />ls
+Directory /:
+dir_test            <DIR>
+```
+

mkdir/mkdir.c

@@ -0,0 +1,32 @@
+/*
+ * 程序清单：创建目录
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 mkdir() 函数
+ * int mkdir(const char *path, mode_t mode);
+ * mkdir()函数用来创建一个目录，参数path 为目录名，
+ * 参数mode 在当前版本未启用，输入0x777 即可。
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+static void mkdir_sample(void)
+{
+    int ret;
+
+    /* 创建目录*/
+    ret = mkdir("/dir_test", 0x777);
+    if (ret < 0)
+    {
+        /* 创建目录失败*/
+        rt_kprintf("dir error!\n");
+    }
+    else
+    {
+        /* 创建目录成功*/
+        rt_kprintf("mkdir ok!\n");
+    }
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(mkdir_sample, mkdir sample);
+

opendir/README.md

@@ -0,0 +1,54 @@
+# 打开目录 #
+
+## 介绍 ##
+
+这个例程展示了如何打开目录。
+
+## 程序清单 ##
+
+```{.c}
+/*
+ * 程序清单：打开目录
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 opendir() 函数
+ * DIR* opendir(const char* name);
+ * opendir()函数用来打开一个目录，参数name 为目录路径名。
+ * 若读取目录成功，返回该目录结构，若读取目录失败，返回RT_NULL。
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+static void opendir_sample(void)
+{
+    DIR *dirp;
+    /* 打开/dir_test 目录*/
+    dirp = opendir("/dir_test");
+    if (dirp == RT_NULL)
+    {
+        rt_kprintf("open directory error!\n");
+    }
+    else
+    {
+        rt_kprintf("open directory OK!\n");
+        /* 在这儿进行读取目录相关操作*/
+        /* ...... */
+
+        /* 关闭目录 */
+        closedir(dirp);
+    }
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(opendir_sample, open dir sample);
+```
+
+## 运行结果 ##
+
+```
+msh />ls
+Directory /:
+dir_test            <DIR>
+msh />opendir_sample
+open directory OK!
+```
+

opendir/opendir.c

@@ -0,0 +1,33 @@
+/*
+ * 程序清单：打开目录
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 opendir() 函数
+ * DIR* opendir(const char* name);
+ * opendir()函数用来打开一个目录，参数name 为目录路径名。
+ * 若读取目录成功，返回该目录结构，若读取目录失败，返回RT_NULL。
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+static void opendir_sample(void)
+{
+    DIR *dirp;
+    /* 打开/dir_test 目录*/
+    dirp = opendir("/dir_test");
+    if (dirp == RT_NULL)
+    {
+        rt_kprintf("open directory error!\n");
+    }
+    else
+    {
+        rt_kprintf("open directory OK!\n");
+        /* 在这儿进行读取目录相关操作*/
+        /* ...... */
+
+        /* 关闭目录 */
+        closedir(dirp);
+    }
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(opendir_sample, open dir sample);

openfile/README.md

@@ -0,0 +1,62 @@
+# 打开文件 #
+
+## 介绍 ##
+
+这个例程展示了如何打开、关闭文件，并进行简单的读写操作。
+
+## 程序清单 ##
+
+```{.c}
+/*
+ * 程序清单：打开文件
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 open() close() 函数
+ * int open(const char *pathname, int oflag, int mode); 打开或创建一个文件
+ * int close(int fd);关闭文件
+ *
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+static void openfile_sample(void *parameter)
+{
+    int fd, size;
+    char s[] = "RT-Thread Programmer!\n", buffer[80];
+
+    /* 打开/text.txt 作写入，如果该文件不存在则建立该文件*/
+    fd = open("/text.txt", O_WRONLY | O_CREAT);
+    if (fd >= 0)
+    {
+        write(fd, s, sizeof(s));
+        close(fd);
+    }
+
+    /* 打开/text.txt 准备作读取动作*/
+    fd = open("/text.txt", O_RDONLY);
+    if (fd >= 0)
+    {
+        size = read(fd, buffer, sizeof(buffer));
+        close(fd);
+    }
+
+    rt_kprintf("%s", buffer);
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(openfile_sample, open file sample);
+```
+
+## 运行结果 ##
+
+```
+msh />openfile_sample
+RT-Thread Programmer!
+msh />ls
+Directory /:
+dir_test            <DIR>
+text.txt            23
+msh />cat text.txt
+RT-Thread Programmer!
+```
+
+可以看到创建了 text.txt 文件，并在文件中写入了 "RT-Thread Programmer!\n" 字符串。

openfile/openfile.c

@@ -0,0 +1,37 @@
+/*
+ * 程序清单：打开文件
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 open() close() 函数
+ * int open(const char *pathname, int oflag, int mode); 打开或创建一个文件
+ * int close(int fd);关闭文件
+ *
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+static void openfile_sample(void *parameter)
+{
+    int fd, size;
+    char s[] = "RT-Thread Programmer!\n", buffer[80];
+
+    /* 打开/text.txt 作写入，如果该文件不存在则建立该文件*/
+    fd = open("/text.txt", O_WRONLY | O_CREAT);
+    if (fd >= 0)
+    {
+        write(fd, s, sizeof(s));
+        close(fd);
+    }
+
+    /* 打开/text.txt 准备作读取动作*/
+    fd = open("/text.txt", O_RDONLY);
+    if (fd >= 0)
+    {
+        size = read(fd, buffer, sizeof(buffer));
+        close(fd);
+    }
+
+    rt_kprintf("%s", buffer);
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(openfile_sample, open file sample);

readdir/README.md

@@ -0,0 +1,64 @@
+# 读取目录 #
+
+## 介绍 ##
+
+这个例程展示了如何读取目录。
+
+## 程序清单 ##
+
+```{.c}
+/*
+ * 程序清单：读取目录
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 readdir() 函数
+ * struct dirent* readdir(DIR *d);
+ * readdir()函数用来读取目录，参数d 为目录路径名。
+ * 返回值为读到的目录项结构，如果返回值为RT_NULL，则表示已经读到目录尾；
+ * 此外，每读取一次目录，目录流的指针位置将自动往后递推1 个位置。
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+static void readdir_sample(void)
+{
+    DIR *dirp;
+    struct dirent *d;
+
+    /* 打开/dir_test 目录*/
+    dirp = opendir("/dir_test");
+    if (dirp == RT_NULL)
+    {
+        rt_kprintf("open directory error!\n");
+    }
+    else
+    {
+        /* 读取目录*/
+        while ((d = readdir(dirp)) != RT_NULL)
+        {
+            rt_kprintf("found %s\n", d->d_name);
+        }
+
+        /* 关闭目录 */
+        closedir(dirp);
+    }
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(readdir_sample, readdir sample);
+```
+
+## 运行结果 ##
+
+```
+msh />ls
+Directory /:
+dir_test            <DIR>
+text.txt            23
+msh />cd dir_test
+msh /dir_test>echo "hello" hello.txt
+msh /dir_test>cd ..
+msh />readdir_sample
+found hello.txt
+```
+
+在 dir_test 文件夹下创建 hello.txt 文件后，可以通过示例代码来获得文件夹下的内容。 

readdir/readdir.c

@@ -0,0 +1,38 @@
+/*
+ * 程序清单：读取目录
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 readdir() 函数
+ * struct dirent* readdir(DIR *d);
+ * readdir()函数用来读取目录，参数d 为目录路径名。
+ * 返回值为读到的目录项结构，如果返回值为RT_NULL，则表示已经读到目录尾；
+ * 此外，每读取一次目录，目录流的指针位置将自动往后递推1 个位置。
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+static void readdir_sample(void)
+{
+    DIR *dirp;
+    struct dirent *d;
+
+    /* 打开/dir_test 目录*/
+    dirp = opendir("/dir_test");
+    if (dirp == RT_NULL)
+    {
+        rt_kprintf("open directory error!\n");
+    }
+    else
+    {
+        /* 读取目录*/
+        while ((d = readdir(dirp)) != RT_NULL)
+        {
+            rt_kprintf("found %s\n", d->d_name);
+        }
+
+        /* 关闭目录 */
+        closedir(dirp);
+    }
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(readdir_sample, readdir sample);

readwrite/README.md

@@ -0,0 +1,145 @@
+# 文件读写 #
+
+## 介绍 ##
+
+这个例程展示了如何进行文件读写。
+
+## 程序清单 ##
+
+```{.c}
+/*
+ * 代码清单：文件读写例子
+ *
+ * 这个例子演示了如何读写一个文件，特别是写的时候应该如何操作。
+ */
+
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+#define TEST_FN     "/test.dat"
+
+/* 测试用的数据和缓冲 */
+static char test_data[120], buffer[120];
+
+static void readwrite_sample(void)
+{
+    int fd;
+    int index, length;
+
+    /* 只写 & 创建 打开 */
+    fd = open(TEST_FN, O_WRONLY | O_CREAT | O_TRUNC, 0);
+    if (fd < 0)
+    {
+        rt_kprintf("open file for write failed\n");
+        return;
+    }
+
+    /* 准备写入数据 */
+    for (index = 0; index < sizeof(test_data); index ++)
+    {
+        test_data[index] = index + 48;
+    }
+
+    /* 写入数据 */
+    length = write(fd, test_data, sizeof(test_data));
+    if (length != sizeof(test_data))
+    {
+        rt_kprintf("write data failed\n");
+        close(fd);
+        return;
+    }
+
+    /* 关闭文件 */
+    close(fd);
+
+    /* 只写并在末尾添加打开 */
+    fd = open(TEST_FN, O_WRONLY | O_CREAT | O_APPEND, 0);
+    if (fd < 0)
+    {
+        rt_kprintf("open file for append write failed\n");
+        return;
+    }
+
+    length = write(fd, test_data, sizeof(test_data));
+    if (length != sizeof(test_data))
+    {
+        rt_kprintf("append write data failed\n");
+        close(fd);
+        return;
+    }
+    /* 关闭文件 */
+    close(fd);
+
+    /* 只读打开进行数据校验 */
+    fd = open(TEST_FN, O_RDONLY, 0);
+    if (fd < 0)
+    {
+        rt_kprintf("check: open file for read failed\n");
+        return;
+    }
+
+    /* 读取数据(应该为第一次写入的数据) */
+    length = read(fd, buffer, sizeof(buffer));
+    if (length != sizeof(buffer))
+    {
+        rt_kprintf("check: read file failed\n");
+        close(fd);
+        return;
+    }
+
+    /* 检查数据是否正确 */
+    for (index = 0; index < sizeof(test_data); index ++)
+    {
+        if (test_data[index] != buffer[index])
+        {
+            rt_kprintf("check: check data failed at %d\n", index);
+            close(fd);
+            return;
+        }
+    }
+
+    /* 读取数据(应该为第二次写入的数据) */
+    length = read(fd, buffer, sizeof(buffer));
+    if (length != sizeof(buffer))
+    {
+        rt_kprintf("check: read file failed\n");
+        close(fd);
+        return;
+    }
+
+    /* 检查数据是否正确 */
+    for (index = 0; index < sizeof(test_data); index ++)
+    {
+        if (test_data[index] != buffer[index])
+        {
+            rt_kprintf("check: check data failed at %d\n", index);
+            close(fd);
+            return;
+        }
+    }
+
+    /* 检查数据完毕，关闭文件 */
+    close(fd);
+    /* 打印结果 */
+    rt_kprintf("read/write done.\n");
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(readwrite_sample, readwrite sample);
+```
+
+## 运行结果 ##
+
+```
+msh />readwrite_sample
+read/write done.
+msh />ls
+Directory /:
+dir_test            <DIR>
+text.txt            23
+test.dat            240
+msh />cat test.dat
+0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~ÇüéâäàåçêëèïîìÄÅÉæÆôöòûùÿÖÜ¢£¥₧ƒáíóúñѪº0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~ÇüéâäàåçêëèïîìÄÅÉæÆôöòûùÿÖÜ¢£¥₧ƒáíóúñÑ
+ªº
+```
+
+运行示例代码后，可以看到程序分两次向 test.dat 文件中写入了 240 个字符的数据，第二次写入的数据追加在第一次写入的数据之后。

readwrite/readwrite.c

@@ -0,0 +1,118 @@
+/*
+ * 代码清单：文件读写例子
+ *
+ * 这个例子演示了如何读写一个文件，特别是写的时候应该如何操作。
+ */
+
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+#define TEST_FN     "/test.dat"
+
+/* 测试用的数据和缓冲 */
+static char test_data[120], buffer[120];
+
+static void readwrite_sample(void)
+{
+    int fd;
+    int index, length;
+
+    /* 只写 & 创建 打开 */
+    fd = open(TEST_FN, O_WRONLY | O_CREAT | O_TRUNC, 0);
+    if (fd < 0)
+    {
+        rt_kprintf("open file for write failed\n");
+        return;
+    }
+
+    /* 准备写入数据 */
+    for (index = 0; index < sizeof(test_data); index ++)
+    {
+        test_data[index] = index + 48;
+    }
+
+    /* 写入数据 */
+    length = write(fd, test_data, sizeof(test_data));
+    if (length != sizeof(test_data))
+    {
+        rt_kprintf("write data failed\n");
+        close(fd);
+        return;
+    }
+
+    /* 关闭文件 */
+    close(fd);
+
+    /* 只写并在末尾添加打开 */
+    fd = open(TEST_FN, O_WRONLY | O_CREAT | O_APPEND, 0);
+    if (fd < 0)
+    {
+        rt_kprintf("open file for append write failed\n");
+        return;
+    }
+
+    length = write(fd, test_data, sizeof(test_data));
+    if (length != sizeof(test_data))
+    {
+        rt_kprintf("append write data failed\n");
+        close(fd);          
+        return;
+    }
+    /* 关闭文件 */
+    close(fd);
+
+    /* 只读打开进行数据校验 */
+    fd = open(TEST_FN, O_RDONLY, 0);
+    if (fd < 0)
+    {
+        rt_kprintf("check: open file for read failed\n");
+        return;
+    }
+
+    /* 读取数据(应该为第一次写入的数据) */
+    length = read(fd, buffer, sizeof(buffer));
+    if (length != sizeof(buffer))
+    {
+        rt_kprintf("check: read file failed\n");
+        close(fd);
+        return;
+    }
+
+    /* 检查数据是否正确 */
+    for (index = 0; index < sizeof(test_data); index ++)
+    {
+        if (test_data[index] != buffer[index])
+        {
+            rt_kprintf("check: check data failed at %d\n", index);
+            close(fd);
+            return;
+        }
+    }
+
+    /* 读取数据(应该为第二次写入的数据) */
+    length = read(fd, buffer, sizeof(buffer));
+    if (length != sizeof(buffer))
+    {
+        rt_kprintf("check: read file failed\n");
+        close(fd);
+        return;
+    }
+
+    /* 检查数据是否正确 */
+    for (index = 0; index < sizeof(test_data); index ++)
+    {
+        if (test_data[index] != buffer[index])
+        {
+            rt_kprintf("check: check data failed at %d\n", index);
+            close(fd);
+            return;
+        }
+    }
+
+    /* 检查数据完毕，关闭文件 */
+    close(fd);
+    /* 打印结果 */
+    rt_kprintf("read/write done.\n");
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(readwrite_sample, readwrite sample);

rename/README.md

@@ -0,0 +1,50 @@
+# 更改名称 #
+
+## 介绍 ##
+
+这个例程展示了如何更改文件名称。
+
+## 程序清单 ##
+
+```{.c}
+/*
+ * 程序清单：更改名称
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 rename()函数
+ * int rename(const char *oldpath, const char *newpath);
+ * rename()会将参数oldpath 所指定的文件名称改为参数newpath
+ * 所指的文件名称。若newpath 所指定的文件已经存在，则该文件将会被覆盖。
+ *
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+static void rename_sample(void)
+{
+    rt_kprintf("%s => %s ", "/text.txt", "/text1.txt");
+
+    if (rename("/text.txt", "/text1.txt") < 0)
+        rt_kprintf("[error!]\n");
+    else
+        rt_kprintf("[ok!]\n");
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(rename_sample, rename sample);
+```
+
+## 运行结果 ##
+
+```
+msh />echo "hello" text.txt
+msh />ls
+Directory /:
+text.txt            5
+msh />rename_sample
+/text.txt => /text1.txt [ok!]
+msh />ls
+Directory /:
+text1.txt           5
+```
+
+我们先使用 echo 命令创建文件 text.txt，接着运行示例代码将其文件名修改为 text1.txt。

rename/rename.c

@@ -0,0 +1,24 @@
+/*
+ * 程序清单：更改名称
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 rename()函数
+ * int rename(const char *oldpath, const char *newpath);
+ * rename()会将参数oldpath 所指定的文件名称改为参数newpath
+ * 所指的文件名称。若newpath 所指定的文件已经存在，则该文件将会被覆盖。
+ *
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+static void rename_sample(void)
+{
+    rt_kprintf("%s => %s ", "/text.txt", "/text1.txt");
+
+    if (rename("/text.txt", "/text1.txt") < 0)
+        rt_kprintf("[error!]\n");
+    else
+        rt_kprintf("[ok!]\n");
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(rename_sample, rename sample);

stat/README.md

@@ -0,0 +1,34 @@
+# 取得状态 #
+
+这个例程展示了如何取得文件状态。
+
+## 程序清单 ##
+
+```{.c}
+/*
+ * 程序清单：取得状态
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 stat() 函数
+ * int stat(const char *file_name, struct stat *buf);
+ * stat()函数用来将参数file_name 所指向的文件状态，
+ * 复制到buf 指针所指的结构中(struct stat)。
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+static void stat_sample(void)
+{
+    int ret;
+    struct stat buf;
+    ret=stat("/text.txt", &buf);
+    if(ret == 0)
+        rt_kprintf("text.txt file size = %d\n", buf.st_size);
+    else
+        rt_kprintf("text.txt file not fonud\n");
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(stat_sample, show text.txt stat sample);
+```
+
+通过 echo 命令创建文件 text.txt 后，可以通过示例代码来获取文件状态信息。

stat/stat.c

@@ -0,0 +1,24 @@
+/*
+ * 程序清单：取得状态
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 stat() 函数
+ * int stat(const char *file_name, struct stat *buf);
+ * stat()函数用来将参数file_name 所指向的文件状态，
+ * 复制到buf 指针所指的结构中(struct stat)。
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+static void stat_sample(void)
+{
+    int ret;
+    struct stat buf;
+    ret=stat("/text.txt", &buf);
+    if(ret==0)
+        rt_kprintf("text.txt file size = %d\n", buf.st_size);
+    else
+        rt_kprintf("text.txt file not fonud\n");
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(stat_sample, show text.txt stat sample);

tell_seek_dir/README.md

@@ -0,0 +1,82 @@
+# 保存与设置读取目录位置 #
+
+这个例程展示了如何取得保存与设置读取目录位置。
+
+## 程序清单 ##
+
+```{.c}
+/*
+ * 程序清单：保存与设置读取目录位置
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 telldir() 函数
+ * off_t telldir(DIR *d); 获取目录流的读取位置
+ * void seekdir(DIR *d, off_t offset); 设置下次读取目录的位置
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+/* 假设文件操作是在一个线程中完成 */
+static void telldir_sample(void)
+{
+    DIR *dirp;
+    int save3 = 0;
+    int cur;
+    int i = 0;
+    struct dirent *dp;
+
+    /* 打开根目录 */
+    dirp = opendir("/");
+    for (dp = readdir(dirp); dp != RT_NULL; dp = readdir(dirp))
+    {
+        /* 保存第三个目录项的目录指针*/
+        i++;
+        if (i == 3)
+            save3 = telldir(dirp);
+
+        rt_kprintf("%s\n", dp->d_name);
+    }
+
+    /* 回到刚才保存的第三个目录项的目录指针*/
+    seekdir(dirp, save3);
+
+    /* 检查当前目录指针是否等于保存过的第三个目录项的指针. */
+    cur = telldir(dirp);
+    if (cur != save3)
+    {
+        rt_kprintf("seekdir (d, %ld); telldir (d) == %ld\n", save3, cur);
+    }
+
+    /* 从第三个目录项开始打印*/
+    for (dp = readdir(dirp); dp != NULL; dp = readdir(dirp))
+        rt_kprintf("%s\n", dp->d_name);
+
+    /* 关闭目录*/
+    closedir(dirp);
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(telldir_sample, telldir sample);
+```
+
+## 运行结果 ##
+
+```
+msh />ls
+Directory /:
+hello_1             <DIR>
+hello_2             <DIR>
+hello_3             <DIR>
+hello_4             <DIR>
+hello_5             <DIR>
+msh />telldir_sample
+hello_1
+hello_2
+hello_3
+hello_4
+hello_5
+hello_3
+hello_4
+hello_5
+```
+
+可以看到根目录下有5个文件夹，此时运行示例程序。第一次读取根目录时从第一个文件夹开始读取，然后使用 `seekdir` 函数设置了第二次读取的位置为第三个文件夹的位置。因此第二次读取根目录时，系统从第三个文件夹开始读取直到最后一个文件夹。

tell_seek_dir/tell_seek_dir.c

@@ -0,0 +1,51 @@
+/*
+ * 程序清单：保存与设置读取目录位置
+ *
+ * 程序会创建一个操作文件的函数并导出到msh命令列表
+ * 在函数中调用 telldir() 函数
+ * off_t telldir(DIR *d); 获取目录流的读取位置
+ * void seekdir(DIR *d, off_t offset); 设置下次读取目录的位置
+*/
+#include <rtthread.h>
+#include <dfs_posix.h> /* 当需要使用文件操作时，需要包含这个头文件 */
+
+/* 假设文件操作是在一个线程中完成 */
+static void telldir_sample(void)
+{
+    DIR *dirp;
+    int save3 = 0;
+    int cur;
+    int i = 0;
+    struct dirent *dp;
+
+    /* 打开根目录 */
+    dirp = opendir("/");
+    for (dp = readdir(dirp); dp != RT_NULL; dp = readdir(dirp))
+    {
+        /* 保存第三个目录项的目录指针*/
+        i++;
+        if (i == 3)
+            save3 = telldir(dirp);
+
+        rt_kprintf("%s\n", dp->d_name);
+    }
+
+    /* 回到刚才保存的第三个目录项的目录指针*/
+    seekdir(dirp, save3);
+
+    /* 检查当前目录指针是否等于保存过的第三个目录项的指针. */
+    cur = telldir(dirp);
+    if (cur != save3)
+    {
+        rt_kprintf("seekdir (d, %ld); telldir (d) == %ld\n", save3, cur);
+    }
+
+    /* 从第三个目录项开始打印*/
+    for (dp = readdir(dirp); dp != NULL; dp = readdir(dirp))
+        rt_kprintf("%s\n", dp->d_name);
+
+    /* 关闭目录*/
+    closedir(dirp);
+}
+/* 导出到 msh 命令列表中 */
+MSH_CMD_EXPORT(telldir_sample, telldir sample);