Skip to content

Commit

Permalink
Update README for rBoot/Storage
Browse files Browse the repository at this point in the history
  • Loading branch information
mikee47 committed Mar 13, 2021
1 parent 8903bb1 commit 93c7a48
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
4 changes: 3 additions & 1 deletion Sming/Components/Storage/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,9 @@ In your custom profile you'd add the line:
"base_config": "legacy/spiffs"
Your OTA update process must include a step to write the partition table to the correct location.


It is not necessary to update the bootloader. See :component:`rboot` for further information.


Custom configurations
---------------------
Expand Down
16 changes: 15 additions & 1 deletion Sming/Components/rboot/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,24 @@ pre-configured flash memory addresses, called "slots". Sming supports up to thre
.. note::

With Sming 4.3 partitions are used to manage flash storage.
A "slot" refers to a specific application partition, namely ``rom0``, ``rom1`` or ``rom2``.
A "slot" refers to a specific application partition, typically ``rom0``, ``rom1`` or ``rom2``.

The location or size of these partitions is determined by the :ref:`hardware_config`.

The bootloader has been modified to use the partition table as reference, identifying slots
by the partition sub-type.

Where systems are to be updated Over the Air (OTA) at least two application partitions are required.
The bootloader identifies these by their partition subtype: ``slot #0`` -> ``App/Ota_0``, ``slot #1`` -> ``App/Ota_1``, etc.

Fixed applications without OTA capability use a single application image.
This must be the ``App/Factory`` partition type, and corresponds to ``slot #0``.

At startup, the bootloader will use the partition table to locate the application image.
It will also ensure that the ROM slot information in the boot configuration is consistent,
and update it if necessary.


.. attention::

Make sure that your slots do not extend beyond a 1MB boundary and
Expand Down

0 comments on commit 93c7a48

Please sign in to comment.