Skip to content

Commit df53184

Browse files
aescolarcarlescufi
authored andcommitted
docs boards native_sim: Improve FUSE FS access description
The FUSE driver allows accessing a possible filesystem, independently of the underlaying device, so let's correct the description so we do not mix "flash" with "filesystem". Also, one does not need to create the 'flash' folder these days. The FUSE library will if needed. Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
1 parent 65018e2 commit df53184

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

boards/native/native_sim/doc/index.rst

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@ The following peripherals are currently provided with this board:
469469
Some more information can be found in :ref:`the emulators page <emul_flash_simu_brief>`.
470470

471471
The flash content can be accessed from the host system, as explained in the
472-
`Host based flash access`_ section.
472+
`Host (FUSE) filesystem access`_ section.
473473

474474
**Input events**
475475
Two optional native input drivers are available:
@@ -646,21 +646,18 @@ All :ref:`available HW emulators <emulators>` can be used with native_sim.
646646

647647
.. _native_fuse_flash:
648648

649-
Host based flash access
650-
***********************
649+
Host (FUSE) filesystem access
650+
*****************************
651651

652-
If a flash device is present, the file system partitions on the flash
653-
device can be exposed through the host file system by enabling
654-
:kconfig:option:`CONFIG_FUSE_FS_ACCESS`. This option enables a FUSE
655-
(File system in User space) layer that maps the Zephyr file system calls to
656-
the required UNIX file system calls, and provides access to the flash file
657-
system partitions with normal operating system commands such as ``cd``,
658-
``ls`` and ``mkdir``.
652+
When building Zephyr with a filesystem, the device partitions can be exposed through the host file
653+
system by enabling :kconfig:option:`CONFIG_FUSE_FS_ACCESS`. This option enables a FUSE
654+
(File system in User space) layer that mounts the simulated embedded filesystem in the host
655+
filesystem, maps the Zephyr file system calls to the required UNIX file system calls, and provides
656+
access to its partitions with normal operating system commands such as ``cd``, ``ls`` and ``mkdir``.
659657

660658
By default the partitions are exposed through the directory :file:`flash/` in the
661659
current working directory. This directory can be changed via the command line
662-
option ``--flash-mount``. As this directory operates as a mount point for FUSE
663-
you have to ensure that it exists before starting the native_sim board.
660+
option ``--flash-mount``.
664661

665662
On exit, the native_sim board application will take care of unmounting the
666663
directory. In the unfortunate case that the native_sim board application
@@ -707,7 +704,7 @@ host libC (:kconfig:option:`CONFIG_EXTERNAL_LIBC`):
707704
EEPROM, EEPROM emulator, :kconfig:option:`CONFIG_EEPROM_EMULATOR`, All
708705
Ethernet, :ref:`Eth native_tap <nsim_per_ethe>`, :kconfig:option:`CONFIG_ETH_NATIVE_TAP`, All
709706
Flash, :ref:`Flash simulator <nsim_per_flash_simu>`, :kconfig:option:`CONFIG_FLASH_SIMULATOR`, All
710-
Flash, :ref:`Host based flash access <native_fuse_flash>`, :kconfig:option:`CONFIG_FUSE_FS_ACCESS`, All
707+
FUSE, :ref:`Host based filesystem access <native_fuse_flash>`, :kconfig:option:`CONFIG_FUSE_FS_ACCESS`, All
711708
GPIO, GPIO emulator, :kconfig:option:`CONFIG_GPIO_EMUL`, All
712709
GPIO, SDL GPIO emulator, :kconfig:option:`CONFIG_GPIO_EMUL_SDL`, All
713710
I2C, I2C emulator, :kconfig:option:`CONFIG_I2C_EMUL`, All

0 commit comments

Comments
 (0)