MicroPython中的文件系统

该文档介绍了MicroPython如何在设备上构建文件系统，以允许用户使用标准Python文件输入/输出方法来进行持久化存储。其启动后会自动检测所适合的主文件系统并创建默认配置，因此，该篇文档的作用主要体现在你需要修改默认分区和文件系统类型或使用自定义块设备的时候。

文件系统通常构建在设备上的片内Flash存储器上，但也可以构建在外部Flash，RAM或者自定义块设备上。在某些移植版本上(比如STM32)，文件系统能够以USB大容量存储设备形式同时供主机电脑使用。pyboard.py工具还为主机电脑提供了一种访问所有MicroPython移植版本上文件系统的方法。

注意：此处所述文件系统主要用于STM32和ESP32等裸机移植版本，而在其本身已带有操作系统的移植版本上(比如Unix移植版本)，文件系统由主机系统来提供。

VFS

MicroPython实现了类Unix的虚拟文件系统(VFS)层。所有挂载的文件系统均被合并到一个以"/"为根节点而开始的虚拟文件系统中，文件系统以目录结构的形式进行挂载，并且在设备启动时，当前工作目录被自动切换到主文件系统所在之处。

在STM32/Pyboard上，片内Flash会被挂载到/flash目录，若已插入SD卡，其可以被挂载到的/sd目录。在ESP8266/ESP32上，主文件系统则会被挂载到"/"目录。

块设备

每个块设备均对应为实现了uos.AbstractBlockDev接口协议的类实例，该接口协议包含简单接口和扩展接口，简单接口可为FAT文件系统所用，扩展接口可为littlefs文件系统所用。

1> 内置块设备

MicroPython各移植版本均提供了内置块设备以存取其主Flash。

设备上电时，MicroPython会自动检测默认Flash上所用文件系统并进行适当配置和挂载。如果未检测到文件系统，其进而会尝试在整个Flash上建立FAT文件系统。MicroPython各移植版本一般还提供对主Flash进行“恢复出厂设置”的方法，通常由在上电时按适当的组合按键来进行。

2> STM32/Pyboard

pyb.Flash类提供了对片内Flash的存取方法。在一些具有更大容量外部Flash的开发板上(比如Pyboard D)，其会转而使用外部Flash。该类的start参数应总是传递实际有效值，不推荐为空，比如pyb.Flash(start = 0)。

注意，为了向后兼容，当该类进行无参构造时(比如pyb.Flash())，其仅实现了简单块设备接口，并将以USB大容量存储形式的虚拟设备进行展现(即在开始包含一个虚拟分区表)。

3> ESP8266

其板载Flash以块设备对象的形式进行展现，该对象由flashbdev模块在系统开机的时候进行创建。该设备对象默认被添加为全局变量，通常可以简单地通过bdev来进行访问，其实现了uos.AbstractBlockDev的扩展接口。

4> ESP32

esp32.Partition类利用开发板上的存储分区实现了块设备接口。和ESP3266一样，全局变量bdev指向了其默认分区，其也实现了uos.AbstractBlockDev的扩展接口。

自定义块设备

如下示例实现了简单块设备接口，其使用bytearray在RAM中存储数据。

class RAMBlockDev:
    def __init__(self, block_size, num_blocks):
        self.block_size = block_size
        self.data = bytearray(block_size * num_blocks)

    def readblocks(self, block_num, buf):
        for i in range(len(buf)):
            buf[i] = self.data[block_num * self.block_size + i]

    def writeblocks(self, block_num, buf):
        for i in range(len(buf)):
            self.data[block_num * self.block_size + i] = buf[i]

    def ioctl(self, op, arg):
        if op == 4: # get number of blocks
            return len(self.data) // self.block_size
        if op == 5: # get block size
            return self.block_size

其能够以如下方式被使用：

import os

bdev = RAMBlockDev(512, 50)
os.VfsFat.mkfs(bdev)
os.mount(bdev, '/ramdisk')

如下示例同时实现了简单块设备接口和扩展块设备接口(能够同时支持带偏移量参数的uos.AbstractBlockDev.readblocks() 和uos.AbstractBlockDev.writeblocks()函数调用)：

class RAMBlockDev:
    def __init__(self, block_size, num_blocks):
        self.block_size = block_size
        self.data = bytearray(block_size * num_blocks)

    def readblocks(self, block_num, buf, offset=0):
        addr = block_num * self.block_size + offset
        for i in range(len(buf)):
            buf[i] = self.data[addr + i]

    def writeblocks(self, block_num, buf, offset=None):
        if offset is None:
            # 先擦除后写入
            for i in range(len(buf) // self.block_size):
                self.ioctl(6, block_num + i)
            offset = 0
        addr = block_num * self.block_size + offset
        for i in range(len(buf)):
            self.data[addr + i] = buf[i]

    def ioctl(self, op, arg):
        if op == 4: # 取得块数量
            return len(self.data) // self.block_size
        if op == 5: # 取得块大小
            return self.block_size
        if op == 6: # 块擦除
            return 0

由于其支持扩展接口，便能够以littlefs文件系统形式被使用：

import os

bdev = RAMBlockDev(512, 50)
os.VfsLfs2.mkfs(bdev)
os.mount(bdev, '/ramdisk')

一旦被挂载后，无论其类型为何，文件系统便都能够以常规形式在Python代码中使用，例如：

with open('/ramdisk/hello.txt', 'w') as f:
    f.write('Hello world')
print(open('/ramdisk/hello.txt').read())

文件系统

MicroPython可以支持FAT,littlefs v1和littlefs v2文件系统。如下表格展示了对于给定移植版本和开发板的组合，默认的系统固件中所包含的文件系统。当然，在你自己构建系统固件时，可以依需要自己选择并将其包含进去。

1> FAT文件系统

FAT文件系统的主要优势是其所支持的开发板能够作为USB大容量存储设备被主机访问，而无需额外的驱动。然而，该文件系统不能够对在写入时掉电的情况进行容错处理，从而可能导致文件系统损坏。对于不需要USB大容量存储设备的应用来讲，推荐使用littlefs文件系统。

采用FAT文件系统格式化flash设备的方法如下：

# ESP8266 and ESP32
import os
os.umount('/')
os.VfsFat.mkfs(bdev)
os.mount(bdev, '/')

# STM32
import os, pyb
os.umount('/flash')
os.VfsFat.mkfs(pyb.Flash(start=0))
os.mount(pyb.Flash(start=0), '/flash')
os.chdir('/flash')

2> Littlefs文件系统

Littlefs文件系统被设计于专门使用在以flash为存储的设备上，其对文件系统损坏的抵抗力更强。

注意：通过安装littlefs FUSE驱动，其也能够被作为USB大容量存储设备而存取。此时，必须使用

-b=4096选项来覆盖其原本块大小。

使用littlefs v2来格式化Flash的方法如下：

# ESP8266 and ESP32
import os
os.umount('/')
os.VfsLfs2.mkfs(bdev)
os.mount(bdev, '/')

# STM32
import os, pyb
os.umount('/flash')
os.VfsLfs2.mkfs(pyb.Flash(start=0))
os.mount(pyb.Flash(start=0), '/flash')
os.chdir('/flash')

3> STM32混合文件系统

通过使用pyb.Flash的start和len关键字参数，可以创建横跨多个flash设备及文件系统的块设备。比如，如下代码可以将其前256KB配置为FAT文件系统(能够以USB大容量存储设备的形式被访问)，剩余部分配置为littlefs：

import os, pyb
os.umount('/flash')
p1 = pyb.Flash(start=0, len=256*1024)
p2 = pyb.Flash(start=256*1024)
os.VfsFat.mkfs(p1)
os.VfsLfs2.mkfs(p2)
os.mount(p1, '/flash')
os.mount(p2, '/data')
os.chdir('/flash')

采用这种方式可以使Python程序文件、配置及其它很少修改的数据能够以USB大容量存储设备的形式被访问，而由于littlefs具有较好的电源故障恢复能力，可以将需要被频繁修改的数据保存其中。

MicroPython中只有偏移量为0的分区会被自动挂载(其文件系统也会被自动检测识别)，但你可以添加如下代码到boot.py中以挂载其它数据分区：

import os, pyb
p2 = pyb.Flash(start=256*1024)
os.mount(p2, '/data')

4> ESP32混合文件系统

在ESP32上，当你构建自定义固件时，可以通过修改partitions.csv文件来定义任意的分区结构。系统启动时，被命名为"vfs"的分区会被默认挂载到"/"目录上，额外的分区可以在boot.py中使用如下代码挂载：

import esp32, os
p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
os.mount(p, '/foo')

相关推荐

idea本地配置连接远程hadoop集群的一些网络问题解决汇总

无缓存不行?例行升级的入门级阿斯加特AN2 SSD装机点评

Ceph运维手册(基于P版本)

Docker 命令大全（docker命令大全记录表）

替代Docker build的Buildah简单介绍

Docker Desktop安装使用指南:零基础教程

大数据开发前要做什么准备?8台Hadoop服务器进行集群规划前配置

Tensorflow分类loss函数总结 tensorflow绘制loss曲线

R语言学习笔记(七) -离散型数据的模型预测2

iOS Runtime详解