diff options
author | Breno Lima <breno.lima@nxp.com> | 2018-12-09 21:08:49 -0200 |
---|---|---|
committer | Ye Li <ye.li@nxp.com> | 2018-12-13 17:48:44 -0800 |
commit | dac930e7352b1294a2ad76bb80bc7ec1739e5b5a (patch) | |
tree | c7f851580a40e0ff9aaecf742a8abc0d09c8f3d2 /doc | |
parent | cba7ec79bb014fe7c107313187448c7c74a1de82 (diff) |
MLK-20553-4 doc: imx: hab: Remove extra hab directory for a cleaner documentation structure
There is no need to have an extra hab directory under doc/imx/:
- doc/imx/hab/ahab/
- doc/imx/hab/habv4/
Remove extra hab directory for a cleaner documentation structure.
Signed-off-by: Breno Lima <breno.lima@nxp.com>
Reviewed-by: Ye Li <ye.li@nxp.com>
(cherry picked from commit 4568f4a4c853ff9d952cfb5ec7c38c479de697d2)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/imx/ahab/csf_examples/csf_boot_image.txt (renamed from doc/imx/hab/ahab/csf_examples/csf_boot_image.txt) | 0 | ||||
-rw-r--r-- | doc/imx/ahab/csf_examples/csf_boot_image_sgk.txt (renamed from doc/imx/hab/ahab/csf_examples/csf_boot_image_sgk.txt) | 0 | ||||
-rw-r--r-- | doc/imx/ahab/csf_examples/csf_linux_img.txt (renamed from doc/imx/hab/ahab/csf_examples/csf_linux_img.txt) | 0 | ||||
-rw-r--r-- | doc/imx/ahab/csf_examples/cst_uboot_atf.txt (renamed from doc/imx/hab/ahab/csf_examples/cst_uboot_atf.txt) | 0 | ||||
-rw-r--r-- | doc/imx/ahab/guides/mx8_mx8x_secure_boot.txt (renamed from doc/imx/hab/ahab/guides/mx8_mx8x_secure_boot.txt) | 4 | ||||
-rw-r--r-- | doc/imx/ahab/guides/mx8_mx8x_spl_secure_boot.txt (renamed from doc/imx/hab/ahab/guides/mx8_mx8x_spl_secure_boot.txt) | 4 | ||||
-rw-r--r-- | doc/imx/ahab/introduction_ahab.txt (renamed from doc/imx/hab/ahab/introduction_ahab.txt) | 6 | ||||
-rw-r--r-- | doc/imx/habv4/csf_examples/additional_images/csf_additional_images.txt (renamed from doc/imx/hab/habv4/csf_examples/additional_images/csf_additional_images.txt) | 0 | ||||
-rw-r--r-- | doc/imx/habv4/csf_examples/mx6_mx7/csf_u-boot_enc.txt (renamed from doc/imx/hab/habv4/csf_examples/mx6_mx7/csf_u-boot_enc.txt) | 0 | ||||
-rw-r--r-- | doc/imx/habv4/csf_examples/mx6_mx7/csf_u-boot_sign_enc.txt (renamed from doc/imx/hab/habv4/csf_examples/mx6_mx7/csf_u-boot_sign_enc.txt) | 0 | ||||
-rw-r--r-- | doc/imx/habv4/csf_examples/mx6_mx7/csf_uboot.txt (renamed from doc/imx/hab/habv4/csf_examples/mx6_mx7/csf_uboot.txt) | 0 | ||||
-rw-r--r-- | doc/imx/habv4/csf_examples/mx6_mx7/csf_uboot_fast_authentication.txt (renamed from doc/imx/hab/habv4/csf_examples/mx6_mx7/csf_uboot_fast_authentication.txt) | 0 | ||||
-rw-r--r-- | doc/imx/habv4/csf_examples/mx8m_mx8mm/csf_fit.txt (renamed from doc/imx/hab/habv4/csf_examples/mx8m_mx8mm/csf_fit.txt) | 0 | ||||
-rw-r--r-- | doc/imx/habv4/csf_examples/mx8m_mx8mm/csf_spl.txt (renamed from doc/imx/hab/habv4/csf_examples/mx8m_mx8mm/csf_spl.txt) | 0 | ||||
-rw-r--r-- | doc/imx/habv4/guides/mx6_mx7_encrypted_boot.txt (renamed from doc/imx/hab/habv4/guides/mx6_mx7_encrypted_boot.txt) | 2 | ||||
-rw-r--r-- | doc/imx/habv4/guides/mx6_mx7_secure_boot.txt (renamed from doc/imx/hab/habv4/guides/mx6_mx7_secure_boot.txt) | 2 | ||||
-rw-r--r-- | doc/imx/habv4/guides/mx8m_mx8mm_secure_boot.txt (renamed from doc/imx/hab/habv4/guides/mx8m_mx8mm_secure_boot.txt) | 2 | ||||
-rw-r--r-- | doc/imx/habv4/introduction_habv4.txt (renamed from doc/imx/hab/habv4/introduction_habv4.txt) | 4 | ||||
-rw-r--r-- | doc/imx/habv4/script_examples/genIVT.pl (renamed from doc/imx/hab/habv4/script_examples/genIVT.pl) | 0 |
19 files changed, 12 insertions, 12 deletions
diff --git a/doc/imx/hab/ahab/csf_examples/csf_boot_image.txt b/doc/imx/ahab/csf_examples/csf_boot_image.txt index 1f296f0900..1f296f0900 100644 --- a/doc/imx/hab/ahab/csf_examples/csf_boot_image.txt +++ b/doc/imx/ahab/csf_examples/csf_boot_image.txt diff --git a/doc/imx/hab/ahab/csf_examples/csf_boot_image_sgk.txt b/doc/imx/ahab/csf_examples/csf_boot_image_sgk.txt index ec42f4f09e..ec42f4f09e 100644 --- a/doc/imx/hab/ahab/csf_examples/csf_boot_image_sgk.txt +++ b/doc/imx/ahab/csf_examples/csf_boot_image_sgk.txt diff --git a/doc/imx/hab/ahab/csf_examples/csf_linux_img.txt b/doc/imx/ahab/csf_examples/csf_linux_img.txt index b5aa523802..b5aa523802 100644 --- a/doc/imx/hab/ahab/csf_examples/csf_linux_img.txt +++ b/doc/imx/ahab/csf_examples/csf_linux_img.txt diff --git a/doc/imx/hab/ahab/csf_examples/cst_uboot_atf.txt b/doc/imx/ahab/csf_examples/cst_uboot_atf.txt index c4d23bcce4..c4d23bcce4 100644 --- a/doc/imx/hab/ahab/csf_examples/cst_uboot_atf.txt +++ b/doc/imx/ahab/csf_examples/cst_uboot_atf.txt diff --git a/doc/imx/hab/ahab/guides/mx8_mx8x_secure_boot.txt b/doc/imx/ahab/guides/mx8_mx8x_secure_boot.txt index 3cdfd75c8e..214b40b4b2 100644 --- a/doc/imx/hab/ahab/guides/mx8_mx8x_secure_boot.txt +++ b/doc/imx/ahab/guides/mx8_mx8x_secure_boot.txt @@ -168,7 +168,7 @@ The CSF contains all the commands that the AHAB executes during the secure boot. These commands instruct the AHAB on which memory areas of the image to authenticate, which keys to install, use and etc. -CSF examples are available under doc/imx/hab/ahab/csf_examples/ +CSF examples are available under doc/imx/ahab/csf_examples/ directory. This csf_boot_image.txt file example should be updated with the offset values @@ -350,7 +350,7 @@ Keep in mind the offsets above to be used with CST/CSF 2.2 Creating the CSF description file for OS container image ------------------------------------------------------------- -CSF examples are available under doc/imx/hab/ahab/csf_examples/ +CSF examples are available under doc/imx/ahab/csf_examples/ directory. This csf_linux_img.txt file example should be updated with the offset values diff --git a/doc/imx/hab/ahab/guides/mx8_mx8x_spl_secure_boot.txt b/doc/imx/ahab/guides/mx8_mx8x_spl_secure_boot.txt index f903358687..bf4bf092d3 100644 --- a/doc/imx/hab/ahab/guides/mx8_mx8x_spl_secure_boot.txt +++ b/doc/imx/ahab/guides/mx8_mx8x_spl_secure_boot.txt @@ -168,7 +168,7 @@ during the secure boot procedure. These commands instruct the AHAB code on which memory areas of the image to authenticate, which keys to install, use and etc. -CSF examples are available under doc/imx/hab/ahab/csf_examples/ directory. +CSF examples are available under doc/imx/ahab/csf_examples/ directory. As explained in section above the mkimage log provides the container and signature block offsets used by the CSF description file: @@ -351,7 +351,7 @@ The lifecycle value should now be 128 (0x80) OEM closed. The procedure for authenticating the OS container is similar as in Non-SPL targets, for a complete procedure please refer to mx8_mx8x_secure_boot.txt -document available under doc/imx/hab/ahab/guides/ directory. +document available under doc/imx/ahab/guides/ directory. References: [1] AN12212: "Software Solutions for Migration Guide from Aarch32 to diff --git a/doc/imx/hab/ahab/introduction_ahab.txt b/doc/imx/ahab/introduction_ahab.txt index fe026ffcc5..4eb5fdc676 100644 --- a/doc/imx/hab/ahab/introduction_ahab.txt +++ b/doc/imx/ahab/introduction_ahab.txt @@ -10,7 +10,7 @@ secure boot concept. Due to the multi-core architecture the Security Controller (SECO) and System Control Unit (SCU) are heavily involved in the secure boot process. -Step-by-step guides are available under doc/imx/hab/ahab/guides/ directory, +Step-by-step guides are available under doc/imx/ahab/guides/ directory, users familiar with AHAB architecture and CST PKI tree generation should refer to this directory instead. @@ -167,7 +167,7 @@ The sequence below explains the i.MX8 and i.MX8x boot flow: SCU by calling the sc_misc_seco_authenticate() API function. In current U-Boot implementation the additional image can be the Linux Kernel binary or the U-Boot proper and ATF. Details about current U-Boot implementation - can be found in AHAB guides included in doc/imx/hab/ahab/guides/ directory. + can be found in AHAB guides included in doc/imx/ahab/guides/ directory. 2. Generating a PKI tree ------------------------- @@ -297,5 +297,5 @@ Table Hash. SRK_1_2_3_4_table.bin The SRK_1_2_3_4_table.bin and SRK_1_2_3_4_fuse.bin files can be used in further -steps as explained in AHAB guides available under doc/imx/hab/ahab/guides/ +steps as explained in AHAB guides available under doc/imx/ahab/guides/ directory. diff --git a/doc/imx/hab/habv4/csf_examples/additional_images/csf_additional_images.txt b/doc/imx/habv4/csf_examples/additional_images/csf_additional_images.txt index bbe489714b..bbe489714b 100644 --- a/doc/imx/hab/habv4/csf_examples/additional_images/csf_additional_images.txt +++ b/doc/imx/habv4/csf_examples/additional_images/csf_additional_images.txt diff --git a/doc/imx/hab/habv4/csf_examples/mx6_mx7/csf_u-boot_enc.txt b/doc/imx/habv4/csf_examples/mx6_mx7/csf_u-boot_enc.txt index 96083a6a58..96083a6a58 100644 --- a/doc/imx/hab/habv4/csf_examples/mx6_mx7/csf_u-boot_enc.txt +++ b/doc/imx/habv4/csf_examples/mx6_mx7/csf_u-boot_enc.txt diff --git a/doc/imx/hab/habv4/csf_examples/mx6_mx7/csf_u-boot_sign_enc.txt b/doc/imx/habv4/csf_examples/mx6_mx7/csf_u-boot_sign_enc.txt index 7e508020af..7e508020af 100644 --- a/doc/imx/hab/habv4/csf_examples/mx6_mx7/csf_u-boot_sign_enc.txt +++ b/doc/imx/habv4/csf_examples/mx6_mx7/csf_u-boot_sign_enc.txt diff --git a/doc/imx/hab/habv4/csf_examples/mx6_mx7/csf_uboot.txt b/doc/imx/habv4/csf_examples/mx6_mx7/csf_uboot.txt index 39986243e4..39986243e4 100644 --- a/doc/imx/hab/habv4/csf_examples/mx6_mx7/csf_uboot.txt +++ b/doc/imx/habv4/csf_examples/mx6_mx7/csf_uboot.txt diff --git a/doc/imx/hab/habv4/csf_examples/mx6_mx7/csf_uboot_fast_authentication.txt b/doc/imx/habv4/csf_examples/mx6_mx7/csf_uboot_fast_authentication.txt index cdb34bcf74..cdb34bcf74 100644 --- a/doc/imx/hab/habv4/csf_examples/mx6_mx7/csf_uboot_fast_authentication.txt +++ b/doc/imx/habv4/csf_examples/mx6_mx7/csf_uboot_fast_authentication.txt diff --git a/doc/imx/hab/habv4/csf_examples/mx8m_mx8mm/csf_fit.txt b/doc/imx/habv4/csf_examples/mx8m_mx8mm/csf_fit.txt index d9218ab431..d9218ab431 100644 --- a/doc/imx/hab/habv4/csf_examples/mx8m_mx8mm/csf_fit.txt +++ b/doc/imx/habv4/csf_examples/mx8m_mx8mm/csf_fit.txt diff --git a/doc/imx/hab/habv4/csf_examples/mx8m_mx8mm/csf_spl.txt b/doc/imx/habv4/csf_examples/mx8m_mx8mm/csf_spl.txt index 39adf7a3eb..39adf7a3eb 100644 --- a/doc/imx/hab/habv4/csf_examples/mx8m_mx8mm/csf_spl.txt +++ b/doc/imx/habv4/csf_examples/mx8m_mx8mm/csf_spl.txt diff --git a/doc/imx/hab/habv4/guides/mx6_mx7_encrypted_boot.txt b/doc/imx/habv4/guides/mx6_mx7_encrypted_boot.txt index d3f71b0a45..0f0a9e2416 100644 --- a/doc/imx/hab/habv4/guides/mx6_mx7_encrypted_boot.txt +++ b/doc/imx/habv4/guides/mx6_mx7_encrypted_boot.txt @@ -98,7 +98,7 @@ secure boot. These commands instruct the HAB on which memory areas of the image to authenticate, which keys to install, use, etc... CSF examples for encrypted boot are available under -doc/imx/hab/habv4/csf_examples/ directory. +doc/imx/habv4/csf_examples/ directory. For both CSF, first part is same compared to the CSF used for the secure boot step. diff --git a/doc/imx/hab/habv4/guides/mx6_mx7_secure_boot.txt b/doc/imx/habv4/guides/mx6_mx7_secure_boot.txt index 16c63c1c76..69ef244dea 100644 --- a/doc/imx/hab/habv4/guides/mx6_mx7_secure_boot.txt +++ b/doc/imx/habv4/guides/mx6_mx7_secure_boot.txt @@ -75,7 +75,7 @@ The CSF contains all the commands that the ROM executes during the secure boot. These commands instruct the HAB on which memory areas of the image to authenticate, which keys to install, use and etc. -CSF examples are available under doc/imx/hab/habv4/csf_examples/ directory. +CSF examples are available under doc/imx/habv4/csf_examples/ directory. A build log containing the "Authenticate Data" parameters is available after the U-Boot build, the example below is a log for mx7dsabresd_defconfig target: diff --git a/doc/imx/hab/habv4/guides/mx8m_mx8mm_secure_boot.txt b/doc/imx/habv4/guides/mx8m_mx8mm_secure_boot.txt index 79cd10d78b..5922a1c31f 100644 --- a/doc/imx/hab/habv4/guides/mx8m_mx8mm_secure_boot.txt +++ b/doc/imx/habv4/guides/mx8m_mx8mm_secure_boot.txt @@ -225,7 +225,7 @@ The CSF contains all the commands that the ROM executes during the secure boot. These commands instruct the HAB code on which memory areas of the image to authenticate, which keys to install, use and etc. -CSF examples are available under doc/imx/hab/habv4/csf_examples/ directory. +CSF examples are available under doc/imx/habv4/csf_examples/ directory. As explained in sections above the SPL is first authenticated by the ROM code and the root of trust is extended to the FIT image, hence two CSF files are diff --git a/doc/imx/hab/habv4/introduction_habv4.txt b/doc/imx/habv4/introduction_habv4.txt index d5804f72bd..25711bbe95 100644 --- a/doc/imx/hab/habv4/introduction_habv4.txt +++ b/doc/imx/habv4/introduction_habv4.txt @@ -14,7 +14,7 @@ operations. This feature is supported in i.MX 50, i.MX 53, i.MX 6, i.MX 7 series and i.MX 8M, i.MX 8MM devices. -Step-by-step guides are available under doc/imx/hab/habv4/guides/ directory, +Step-by-step guides are available under doc/imx/habv4/guides/ directory, users familiar with HAB and CST PKI tree generation should refer to these documents instead. @@ -252,7 +252,7 @@ Table Hash. SRK4_sha256_2048_65537_v3_ca_crt.pem The SRK_1_2_3_4_table.bin and SRK_1_2_3_4_fuse.bin files can be used in further -steps as explained in HAB guides available under doc/imx/hab/habv4/guides/ +steps as explained in HAB guides available under doc/imx/habv4/guides/ directory. References: diff --git a/doc/imx/hab/habv4/script_examples/genIVT.pl b/doc/imx/habv4/script_examples/genIVT.pl index 84a4fcb16f..84a4fcb16f 100644 --- a/doc/imx/hab/habv4/script_examples/genIVT.pl +++ b/doc/imx/habv4/script_examples/genIVT.pl |