docs: design: Update description of the swap tables

This commit updates the description of the swap tables, used to
determine the type of operation to perform or resume at startup, in
order to reflect the changes that were performed in the code to enable
the swap-move strategy to support sectors containing both firmware and
trailer data.

Signed-off-by: Thomas Altenbach <[email protected]>

Author: taltenbach

docs/design.md

@@ -672,39 +672,49 @@ types described above via a set of tables.  These tables are reproduced below.
 ---
 
 ```
-    State I (swap using offset only)
+    State I (swap using offset and swap using move only)
                      | primary slot | secondary slot |
     -----------------+--------------+----------------|
-               magic | Any          | Good           |
+               magic | Not good     | Good           |
             image-ok | Any          | Unset          |
            copy-done | Any          | Set            |
     -----------------+--------------+----------------'
      result: BOOT_SWAP_TYPE_REVERT                   |
     -------------------------------------------------'
 
-    State II
+    State II (swap using offset and swap using move only)
+                     | primary slot | secondary slot |
+    -----------------+--------------+----------------|
+               magic | Good         | Good           |
+            image-ok | Unset        | Unset          |
+           copy-done | Any          | Set            |
+    -----------------+--------------+----------------'
+     result: BOOT_SWAP_TYPE_REVERT                   |
+    -------------------------------------------------'
+
+    State III
                      | primary slot | secondary slot |
     -----------------+--------------+----------------|
                magic | Any          | Good           |
             image-ok | Any          | Unset          |
-           copy-done | Any          | Any            |
+           copy-done | Any          | Unset          |
     -----------------+--------------+----------------'
      result: BOOT_SWAP_TYPE_TEST                     |
     -------------------------------------------------'
 
 
-    State III
+    State IV
                      | primary slot | secondary slot |
     -----------------+--------------+----------------|
                magic | Any          | Good           |
             image-ok | Any          | 0x01           |
-           copy-done | Any          | Any            |
+           copy-done | Any          | Unset          |
     -----------------+--------------+----------------'
      result: BOOT_SWAP_TYPE_PERM                     |
     -------------------------------------------------'
 
 
-    State IV
+    State V
                      | primary slot | secondary slot |
     -----------------+--------------+----------------|
                magic | Good         | Any            |
@@ -715,13 +725,13 @@ types described above via a set of tables.  These tables are reproduced below.
     -------------------------------------------------'
 ```
 
-Any of the above three states results in MCUboot attempting to swap images.
+Any of the above five states results in MCUboot attempting to swap images.
 
 Otherwise, MCUboot does not attempt to swap images, resulting in one of the
-other three swap types, as illustrated by State IV.
+other three swap types, as illustrated by State VI.
 
 ```
-    State V
+    State VI
                      | primary slot | secondary slot |
     -----------------+--------------+----------------|
                magic | Any          | Any            |
@@ -734,7 +744,7 @@ other three swap types, as illustrated by State IV.
     -------------------------------------------------'
 ```
 
-In State V, when no errors occur, MCUboot will attempt to boot the contents of
+In State VI, when no errors occur, MCUboot will attempt to boot the contents of
 the primary slot directly, and the result is `BOOT_SWAP_TYPE_NONE`. If the image
 in the primary slot is not valid, the result is `BOOT_SWAP_TYPE_FAIL`. If a
 fatal error occurs during boot, the result is `BOOT_SWAP_TYPE_PANIC`. If the
@@ -746,7 +756,7 @@ rather than booting an invalid or compromised image.
 
 *An important caveat to the above is the result when a swap is requested*
 *and the image in the secondary slot fails to validate, due to a hashing or*
-*signing error. This state behaves as State IV with the extra action of*
+*signing error. This state behaves as State VI with the extra action of*
 *marking the image in the primary slot as "OK", to prevent further attempts*
 *to swap.*