djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/reference/filesystem.rst: Add detail on how to use littlefs fuse.

Browse Source 
Without the --block_count option the fuse will fail.

Signed-off-by: Damien George <damien@micropython.org>
This commit is contained in:
Damien George 2021-11-08 12:43:18 +11:00
parent 1904833e0c
commit 01f1c3aac2
1 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/reference/filesystem.rst
View File

@ -219,15 +219,6 @@ resistant to filesystem corruption.
situations, for details see `littlefs issue 347`_ and situations, for details see `littlefs issue 347`_ and
`littlefs issue 295`_. `littlefs issue 295`_.
Note: It can be still be accessed over USB MSC using the `littlefs FUSE
driver`_. Note that you must use the ``-b=4096`` option to override the block
size.
.. _littlefs FUSE driver: https://github.com/ARMmbed/littlefs-fuse/tree/master/littlefs
.. _Littlefs: https://github.com/ARMmbed/littlefs
.. _littlefs issue 295: https://github.com/ARMmbed/littlefs/issues/295
.. _littlefs issue 347: https://github.com/ARMmbed/littlefs/issues/347
To format the entire flash using littlefs v2:: To format the entire flash using littlefs v2::
# ESP8266 and ESP32 # ESP8266 and ESP32
@ -243,6 +234,27 @@ To format the entire flash using littlefs v2::
os.mount(pyb.Flash(start=0), '/flash') os.mount(pyb.Flash(start=0), '/flash')
os.chdir('/flash') os.chdir('/flash')
A littlefs filesystem can be still be accessed on a PC over USB MSC using the
`littlefs FUSE driver`_. Note that you must specify both the ``--block_size``
and ``--block_count`` options to override the defaults. For example (after
building the littlefs-fuse executable)::
$ ./lfs --block_size=4096 --block_count=512 -o allow_other /dev/sdb1 mnt
This will allow the board's littlefs filesystem to be accessed at the ``mnt``
directory. To get the correct values of ``block_size`` and ``block_count`` use::
import pyb
f = pyb.Flash(start=0)
f.ioctl(1, 1) # initialise flash in littlefs raw-block mode
block_count = f.ioctl(4, 0)
block_size = f.ioctl(5, 0)
.. _littlefs FUSE driver: https://github.com/littlefs-project/littlefs-fuse
.. _Littlefs: https://github.com/littlefs-project/littlefs
.. _littlefs issue 295: https://github.com/littlefs-project/littlefs/issues/295
.. _littlefs issue 347: https://github.com/littlefs-project/littlefs/issues/347
Hybrid (STM32) Hybrid (STM32)
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~