From 04efc2e861fd987475cfa3e1d52773d7356db46b Mon Sep 17 00:00:00 2001 From: Tamas Ban Date: Thu, 8 Dec 2022 17:46:26 +0100 Subject: [PATCH] docs: fix FIH example command in design.md Signed-off-by: Tamas Ban Change-Id: I3ce8177ad6ae8196b7deb4176c4441f41bbc475a --- docs/design.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/design.md b/docs/design.md index 548580bb..d1b70382 100755 --- a/docs/design.md +++ b/docs/design.md @@ -226,13 +226,13 @@ allows hundreds to thousands of field upgrades in production is recommended. swap-using scratch algorithm assumes that the primary and the secondary image slot areas sizes are equal. The maximum image size available for the application -will be: +will be: ``` maximum-image-size = image-slot-size - image-trailer-size ``` -Where: - `image-slot-size` is the size of the image slot. +Where: + `image-slot-size` is the size of the image slot. `image-trailer-size` is the size of the image trailer. ### [Swap without using scratch](#image-swap-no-scratch) @@ -241,8 +241,8 @@ This algorithm is an alternative to the swap-using-scratch algorithm. It uses an additional sector in the primary slot to make swap possible. The algorithm works as follows: - 1. Moves all sectors of the primary slot up by one sector. - Beginning from N=0: + 1. Moves all sectors of the primary slot up by one sector. + Beginning from N=0: 2. Copies the N-th sector from the secondary slot to the N-th sector of the primary slot. 3. Copies the (N+1)-th sector from the primary slot to the N-th sector of the @@ -257,13 +257,13 @@ The algorithm is limited to support sectors of the same sector layout. All slot's sectors should be of the same size. When using this algorithm the maximum image size available for the application -will be: +will be: ``` maximum-image-size = (N-1) * slot-sector-size - image-trailer-sectors-size ``` -Where: - `N` is the number of sectors in the primary slot. +Where: + `N` is the number of sectors in the primary slot. `image-trailer-sectors-size` is the size of the image trailer rounded up to the total size of sectors its occupied. For instance if the image-trailer-size is equal to 1056 B and the sector size is equal to 1024 B, then @@ -1468,8 +1468,8 @@ are issued from the MCUboot source directory): ```sh $ mkdir docker $ ./ci/fih-tests_install.sh -$ FIH_LEVEL=MCUBOOT_FIH_PROFILE_MEDIUM BUILD_TYPE=RELEASE SKIP_SIZE=2 \ - DAMAGE_TYPE=SIGNATURE ./ci/fih-tests_run.sh +$ FIH_LEVEL=MEDIUM BUILD_TYPE=RELEASE SKIP_SIZE=2 DAMAGE_TYPE=SIGNATURE \ + ./ci/fih-tests_run.sh ``` On the travis CI the environment variables in the last command are set based on the configs provided in the `.travis.yaml`