patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

docs boards native_sim: Add mention about the EEPROM simu

Browse source 
Add a small paragraph about the EEPROM simulator,
and improve slightly the flash simulator section

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
This commit is contained in:
Alberto Escolar Piedras 2024-01-07 10:22:06 +01:00 committed by Carles Cufí
parent a2ad1b64a7
commit b89399ff40
2 changed files with 17 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
boards/posix/native_sim/doc/index.rst
View file

@ -433,10 +433,17 @@ The following peripherals are currently provided with this board:
.. _nsim_per_flash_simu:
**Flash driver**
A flash driver is provided that accesses all flash data through a binary file
on the host file system. The behavior of the flash device can be configured
through the native_sim board devicetree or Kconfig settings under
**EEPROM simulator**
The EEPROM simulator can also be used in the native targets. In these, you have the added feature
of keeping the EEPROM content on a file on the host filesystem.
By default this is kept in the file :file:`eeprom.bin` in the current working directory, but you
can select the location of this file and its name with the command line parameter ``--eeprom``.
Some more information can be found in :ref:`the emulators page <emul_eeprom_simu_brief>`.
**Flash simulator**
The flash simulator can also be used in the native targets. In this you have the option to keep
the flash content in a binary file on the host file system or in RAM. The behavior of the flash
device can be configured through the native_sim board devicetree or Kconfig settings under
:kconfig:option:`CONFIG_FLASH_SIMULATOR`.
By default the binary data is located in the file :file:`flash.bin` in the current
@ -446,6 +453,8 @@ The following peripherals are currently provided with this board:
configuration. In case the file does not exists the driver will take care of
creating the file, else the existing file is used.
Some more information can be found in :ref:`the emulators page <emul_flash_simu_brief>`.
The flash content can be accessed from the host system, as explained in the
`Host based flash access`_ section.

4
doc/hardware/emulator/index.rst
View file

@ -47,6 +47,8 @@ Available Emulators
* Main Kconfig option: :kconfig:option:`CONFIG_EEPROM_EMULATOR`
* DT binding: :dtcompatible:`zephyr,emu-eeprom`
.. _emul_eeprom_simu_brief:
**EEPROM simulator**
* Emulate an EEPROM on RAM
* Main Kconfig option: :kconfig:option:`CONFIG_EEPROM_SIMULATOR`
@ -58,6 +60,8 @@ Available Emulators
* :ref:`Documentation <bus_emul>`
* Allow emulating external buses like I2C or SPI and peripherals connected to them.
.. _emul_flash_simu_brief:
**Flash simulator**
* Emulate a flash on RAM
* Main Kconfig option: :kconfig:option:`CONFIG_FLASH_SIMULATOR`