i.MXRT118x Signed Flashloader

This is example how to create signed flashloader for i.MXRT118x device with EdgeLock firmware included. The aim of this Jupyter notebook is show how to easily create AHAB container with flashloader application from NXP SDK to be loaded with serial downloader mode. The process could be split to several steps.

1. Prerequisites

• SPSDK is needed with examples extension. pip install spsdk[examples] (Please refer to the installation documentation.)

• This example uses RT1180 EVK board

• Obtain an ELE firmware (mxrt1180b0-ahab-container.img) and put it into the inputs folder. Firmware can be obtained from the SDK package

1.1 Compile the flashloader application

As a first step is needed to compile flashloader application itself from NXP SDK.

• Download the NXP MCUXpresso SDK from NXP web site https://mcuxpresso.nxp.com

• Open the flashloader application in your favorite IDE. (Regular path to application: {SDK_root}\boards\evkmimxrt1180\bootloader_examples\flashloader\cm33)

• Compile the flashloader and generate the binary output (In our example we use precompiled flashloader_cm33_exe.bin)

1.2 Prepare the AHAB configuration file

Run this code to initialize members for this example

WORKSPACE = "workspace/"  # change this to path to your workspace
VERBOSITY = (
    "-v"  # verbosity of commands, might be -v or -vv for debug or blank for no additional info
)

BIMG_TEMPLATES_PATH = WORKSPACE + "bootable_image_templates"  # Bootable image templates folder
FLSHLDR_EXE_PATH = (
    "inputs/flashloader_cm33_exe.bin"  # Input compiled flashloader executable in binary format
)
AHAB_CONFIG = "inputs/flashloader_cm33_cfg.yaml"  # Prepared AHAB configuration file
AHAB_FILE = (
    WORKSPACE + "flashloader_cm33_ahab.bin"
)  # File name of created signed AHAB container with flashloader and EdgeLockEnclave firmware
BOOTIMG_CONFIG = (
    "inputs/bootimg_rt118x_serial_downloader.yaml"  # Prepared Bootable image configuration file
)
FLASHLOADER = WORKSPACE + "flashloader.bin"  # Final Bootable flashloader

2. Prepare AHAB configuration YAML file

Modify the template to configuration file used to create AHAB flashloader as a serial downloader mode

nxpimage ahab get-template -f mimxrt1189 -o workspace/ahab_template.yaml --force 
Creating workspace/ahab_template.yaml template file.

Configuration Differences

Show Diff Download Config

# =======================  Advanced High-Assurance Boot Configuration template for mimxrt1189.  ========================

# ======================================================================================================================
#                                                 == General Options ==                                                 
# ======================================================================================================================
# -------------------------------------===== The chip family name [Required] =====--------------------------------------
# Description: NXP chip family identifier.
# Possible options: 
family: mimxrt1189
# -----------------------------------------===== MCU revision [Optional] =====------------------------------------------
# Description: Revision of silicon. The 'latest' name, means most current revision.
# Possible options: 
revision: latest
# -----------------------------------------===== Target memory [Optional] =====-----------------------------------------
# Description: Target memory for AHAB container
# Possible options: 
target_memory: standard Change the target memory to serial downloader
target_memory: serial_downloader
# ---------------------------------------===== Output file name [Required] =====----------------------------------------
# Description: Output AHAB file name
output: generated_ahab.bin Change the output file name
output: ../workspace/flashloader_cm33_ahab.bin
# ------------------------------===== List of containers present in AHAB [Required] =====-------------------------------
# Description: The order of containers in the list defines the order in AHAB.
containers:
  -
  # ====================================================================================================================
  #                                          == List of possible 2 options. ==                                          
  #                                        Options [binary_container, container]                                        
  # ====================================================================================================================

  #  =========================== [Example of possible configuration: #0 , erase if not used] ============================
    # -----------------------------------===== Binary AHAB container [Required] =====-----------------------------------
    # Description: Binary Container format to add to AHAB image, Typically it could be used to add ELE Firmware.
    binary_container:
      # -----------------------------===== The AHAB container binary file [Required] =====------------------------------
      # Description: The binary file that contains AHAB "my_binary_container.bin
      path: my_ahab_container.bin Define the path to the EdgeLock Enclave Firmware container (And clean up the comments about possible
options of container definitions)

  #  =========================== [Example of possible configuration: #1 , erase if not used] ============================
    # --------------------------------------===== AHAB Container [Required] =====---------------------------------------
    # Description: Configurable Container format to add to AHAB image. This allow to configure all aspects of the AHAB
    # container.
    container:
      # --------------------------------===== Super Root Key (SRK) set [Required] =====---------------------------------
      # Description: Defines which set is used to authenticate the container.
      # Possible options: 
      srk_set: none Change srk_set to OEM to sign the image with OEM SRK
      srk_set: oem
      # ---------------------------------===== Used SRK [Conditionally required] =====----------------------------------
      # Description: Which key from SRK set is being used.
      used_srk_id: 0
      # -------------------------------------===== SRK revoke mask [Optional] =====-------------------------------------
      # Description: Bit-mask to indicate which SRKs to revoke. Bit set to 1 means revoke key. Bit 0 = revoke SRK_0, bit
      # 1 = revoke SRK_1 etc. Example of revocation SRK_0 and SRK_1 - the value should be 0x03
      srk_revoke_mask: '0x00'
      srk_revoke_mask: "0x00"
      # ----------------------------------===== GDET runtime behavior [Optional] =====----------------------------------
      # Description: This option defines runtime behavior of Glitch detector. Not supported by all devices and their ELE
      # firmware.
      #  - disabled:       GDET is disabled after the first OEM container has been authenticated (default behavior)
      #  - enabled_eleapi: Automatically enable GDET during all ELE API calls
      #  - enabled:        Leave GDET enabled
      # Possible options: 
      gdet_runtime_behavior: disabled This might be deleted, it is not used on RT1180
      # --------------------------------------===== Fuse version [Optional] =====---------------------------------------
      # Description: The value must be equal or greater than the version stored in fuses to allow loading this
      # container.
      fuse_version: 0
      # ------------------------------------===== Software version [Optional] =====-------------------------------------
      # Description: Number used by Privileged Host Boot Companion (PHBC) to select between multiple images with same
      # Fuse version field.
      sw_version: 0
      # -------------------------------===== AHAB container signing key [Optional] =====--------------------------------
      # Description: Private key used for sign the container header. Header can be signed by SRK. The referenced SRK
      # must not have been revoked.
      signing_key: ../../_data/keys/ecc256/srk0_ecc256.pem
      signing_key: my_signing_key.pem Path to signing key
      # -----------------------------------===== Signature Provider [Optional] =====------------------------------------
      # Description: Signature provider configuration in format 'type=;=;='. The
      # signature provider could be used instead of definition of 'signing_key'.
      signature_provider: type=file;file_path=my_prv_key.pem

      # ================================================================================================================
      #                     == Configuration of AHAB Container images (array of multiple images) ==                     
      # ================================================================================================================
      # ---------------------------------------===== Image array [Required] =====---------------------------------------
      # Description: Array of image entries.
      images:
        -
          # -------------------------------------===== Image path [Optional] =====--------------------------------------
          # Description: Path to image binary (absolute/relative). In case that only Image Array entry without any data
          # image is needed, Just do not use the image path. In case that the image size in container should be aligned
          # differently then SPSDK do (4 bytes for ELE images, 1 byte otherwise), there is hidden option
          # 'image_size_alignment' where could be override image size by any custom value.
          image_path: my_image.bin Define the image executable (compiled flashloader binary).
          image_path: inputs/flashloader_cm33_exe.bin
          # ---------------------------===== Image offset in AHAB container [Optional] =====----------------------------
          # Description: Offset in bytes from start of container header to beginning of the image. Zero value means
          # automatic placing the image with proper alignment after previous one, this is recommended for
          # serial_downloader mode. In case of XiP type of AHAB image, the load_address and entry_point must correspond
          # to this values. Example of setting of load_address - AHAB_IMAGE_ADDRESS+IMAGE_OFFSET=LOAD_ADDRESS. The
          # Booting core images must be located after the other ones
          image_offset: 0 The image offset doesn't matter in serial downloader mode, it's updated automatically if left as 0.
          # ------------------------------===== Image destination address [Required] =====------------------------------
          # Description: Address the image is written to in memory (absolute address in system memory).
          load_address: '0x1FFC_0000' he most important are 'load_address' and 'entry_point' fields that must be sets on same value as is
defined linker file for the application start of the application. In case of i.MXRT118x the linker load address is 0x304a0000
          load_address: '0x304a0000'
          # ----------------------------------===== Image entry point [Required] =====----------------------------------
          # Description: Image entry point (absolute address). Valid only for executable image types.
          entry_point: '0x1FFC_0000'
          entry_point: '0x304a0000'
          # -------------------------------------===== Image type [Required] =====--------------------------------------
          # Description: Kind of image.
          # Possible options: 
          image_type: executable
          # ---------------------------------------===== Core ID [Required] =====---------------------------------------
          # Description: Defines the core the image is dedicated for. Not all cores are supported for all families.
          # Possible options: 
          core_id: cortex-m33
          # ----------------------------------===== Image encryption [Required] =====-----------------------------------
          # Description: Determines, whether image is encrypted or not.
          is_encrypted: false
          # -------------------------------------===== Boot flags [Optional] =====--------------------------------------
          # Description: Boot flags controlling SCFW boot.
          boot_flags: 0 This might be removed
          # ------------------------------------===== Start CPU ID [Optional] =====-------------------------------------
          # Description: Resource ID of CPU to be started
          meta_data_start_cpu_id: 0 This might be removed
          # ------------------------------===== CPU memory unit start ID [Optional] =====-------------------------------
          # Description: Resource ID of the MU associated with the CPU
          meta_data_mu_cpu_id: 0 This might be removed
          # ---------------------------------===== Start partition ID [Optional] =====----------------------------------
          # Description: Partition ID of the partition to start
          meta_data_start_partition_id: 0 This might be removed
          # ----------------------------------===== Images HASH type [Optional] =====-----------------------------------
          # Description: HASH type of image.
          # Possible options: 
          hash_type: sha512

      # ================================================================================================================
      #                                      == Configuration of AHAB SRK table ==                                      
      # ================================================================================================================
      # ---------------------------------===== SRK Table [Conditionally required] =====---------------------------------
      # Description: SRK (Super Root key) table definition.
      srk_table:
        # ----------------------------------------===== CA Flag [Optional] =====----------------------------------------
        # Description: CA Flag is used by HAB to indicate if the SRK is allowed to sign other keys
        flag_ca: false
        # ------------------------------===== Super Root Key (SRK) table [Required] =====-------------------------------
        # Description: Table containing the used SRK records. All SRKs must be of the same type. Supported signing
        # algorithms are: RSA-PSS, ECDSA, Dilithium or SM2. Supported hash algorithms: sha256, sha384, sha512, sha3_256,
        # sha3_384, sha3_512, sm3. Supported key sizes/curves: prime256v1, sec384r1, sec512r1, rsa2048, rsa4096,
        # dilithium3, sm2. Certificate may be of Certificate Authority. Dilithium algorithms are supported just in new
        # type of AHAB container
        srk_array: Define the SRK (Super Root Keys) record. In our case the local pregenerated public keys
          - my_srk_public_key0.pub
          - my_srk_public_key1.pub
          - my_srk_public_key2.pub
          - my_srk_public_key3.pub
          - ../../_data/keys/ecc256/srk0_ecc256.pub
          - ../../_data/keys/ecc256/srk1_ecc256.pub
          - ../../_data/keys/ecc256/srk2_ecc256.pub
          - ../../_data/keys/ecc256/srk3_ecc256.pub

      # ================================================================================================================
      #         == Optional configuration of AHAB Container Encryption blob (if not used, erase the section) ==         
      # ================================================================================================================
      # -------------------------------------===== Encryption blob [Optional] =====-------------------------------------
      # Description: Encryption blob container definition
      blob: And
finally remove unused parts for AHAB Certificate and Encryption blob
        # ------------------------------------===== Key identifier [Required] =====-------------------------------------
        # Description: The key identifier that has been used to generate DEK keyblob.
        key_identifier: 0
        # -------------------------------------===== DEK key size [Required] =====--------------------------------------
        # Description: Data Encryption key size. Used for AES CBC-MAC (128/192/256 size)
        # Possible options: <128, 192, 256>
        dek_key_size: 128
        # ----------------------------------------===== DEK key [Required] =====----------------------------------------
        # Description: Data Encryption key. Used for AES CBC-MAC (128/192/256 size). The HEX format is accepted
        dek_key: my_dek_key.txt
        # --------------------------------------===== DEK keyblob [Optional] =====--------------------------------------
        # Description: Wrapped Data Encryption key. Used for AES CBC-MAC (128/192/256 size). The HEX format is accepted.
        # If NOT used, the empty keyblob is inserted into container and need to be updated later.
        dek_keyblob: my_wrapped_key.txt And finally remove unused parts for AHAB Certificate and Encryption blob

# Copyright 2024 NXP
#
# SPDX-License-Identifier: BSD-3-Clause
# ==============================================  AHAB converted config.  ==============================================

# ======================================================================================================================
#                                                 == General Options ==
# ======================================================================================================================
# -------------------------------------===== The chip family name [Required] =====--------------------------------------
# Description: NXP chip family identifier.
# Possible options: 
family: mimxrt1189
# -----------------------------------------===== MCU revision [Optional] =====------------------------------------------
# Description: Revision of silicon. The 'latest' name, means most current revision.
# Possible options: 
revision: latest
# -----------------------------------------===== Target memory [Optional] =====-----------------------------------------
# Description: Target memory for AHAB container
# Possible options: 
target_memory: serial_downloader Change the target memory to serial downloader
# ---------------------------------------===== Output file name [Required] =====----------------------------------------
# Description: Output AHAB file name
output: ../workspace/flashloader_cm33_ahab.bin Change the output file name
# ------------------------------===== List of containers present in AHAB [Required] =====-------------------------------
# Description: The order of containers in the list defines the order in AHAB.
containers:
  # -
  #   # -----------------------------------===== Binary AHAB container [Required] =====-----------------------------------
  #   # Description: Binary Container format to add to AHAB image, Typically it could be used to add ELE Firmware.
  #   binary_container:
  #     # -----------------------------===== The AHAB container binary file [Required] =====------------------------------
  #     # Description: The binary file that contains AHAB "my_binary_container.bin
  #     path: mxrt1180b0-ahab-container.img
  -
    # --------------------------------------===== AHAB Container [Required] =====---------------------------------------
    # Description: Configurable Container format to add to AHAB image. This allow to configure all aspects of the AHAB
    # container.
    container:
      # --------------------------------===== Super Root Key (SRK) set [Required] =====---------------------------------
      # Description: Defines which set is used to authenticate the container.
      # Possible options: 
      srk_set: oem Change srk_set to OEM to sign the image with OEM SRK
      # ---------------------------------===== Used SRK [Conditionally required] =====----------------------------------
      # Description: Which key from SRK set is being used.
      used_srk_id: 0
      # -------------------------------------===== SRK revoke mask [Optional] =====-------------------------------------
      # Description: Bit-mask to indicate which SRKs to revoke. Bit set to 1 means revoke key. Bit 0 = revoke SRK_0, bit
      # 1 = revoke SRK_1 etc. Example of revocation SRK_0 and SRK_1 - the value should be 0x03
      srk_revoke_mask: "0x00"
      # --------------------------------------===== Fuse version [Optional] =====---------------------------------------
      # Description: The value must be equal or greater than the version stored in fuses to allow loading this
      # container.
      fuse_version: 0
      # ------------------------------------===== Software version [Optional] =====-------------------------------------
      # Description: Number used by Privileged Host Boot Companion (PHBC) to select between multiple images with same
      # Fuse version field.
      sw_version: 0
      # -------------------------------===== AHAB container signing key [Optional] =====--------------------------------
      # Description: Private key used for sign the container header. Header can be signed by SRK. The referenced SRK
      # must not have been revoked.
      signing_key: ../../_data/keys/ecc256/srk0_ecc256.pem Path to signing key

      # ================================================================================================================
      #                     == Configuration of AHAB Container images (array of multiple images) ==
      # ================================================================================================================
      # ---------------------------------------===== Image array [Required] =====---------------------------------------
      # Description: Array of image entries.
      images:
        -
          # -------------------------------------===== Image path [Optional] =====--------------------------------------
          # Description: Path to image binary (absolute/relative). In case that only Image Array entry without any data
          # image is needed, Just do not use the image path. In case that the image size in container should be aligned
          # differently then SPSDK do (4 bytes for ELE images, 1 byte otherwise), there is hidden option
          # 'image_size_alignment' where could be override image size by any custom value.
          image_path: inputs/flashloader_cm33_exe.bin Define the image executable (compiled flashloader binary).
          # ---------------------------===== Image offset in AHAB container [Optional] =====----------------------------
          # Description: Offset in bytes from start of container header to beginning of the image. Zero value means
          # automatic placing the image with proper alignment after previous one, this is recommended for
          # serial_downloader mode. In case of XiP type of AHAB image, the load_address and entry_point must correspond
          # to this values. Example of setting of load_address - AHAB_IMAGE_ADDRESS+IMAGE_OFFSET=LOAD_ADDRESS. The
          # Booting core images must be located after the other ones
          image_offset: 0 The image offset doesn't matter in serial downloader mode, it's updated automatically if left as 0.
          # ------------------------------===== Image destination address [Required] =====------------------------------
          # Description: Address the image is written to in memory (absolute address in system memory).
          load_address: '0x304a0000' he most important are 'load_address' and 'entry_point' fields that must be sets on same value as is
defined linker file for the application start of the application. In case of i.MXRT118x the linker load address is 0x304a0000
          # ----------------------------------===== Image entry point [Required] =====----------------------------------
          # Description: Image entry point (absolute address). Valid only for executable image types.
          entry_point: '0x304a0000'
          # -------------------------------------===== Image type [Required] =====--------------------------------------
          # Description: Kind of image.
          # Possible options: 
          image_type: executable
          # ---------------------------------------===== Core ID [Required] =====---------------------------------------
          # Description: Defines the core the image is dedicated for. Not all cores are supported for all families.
          # Possible options: 
          core_id: cortex-m33
          # ----------------------------------===== Image encryption [Required] =====-----------------------------------
          # Description: Determines, whether image is encrypted or not.
          is_encrypted: false
          # ----------------------------------===== Images HASH type [Optional] =====-----------------------------------
          # Description: HASH type of image.
          # Possible options: 
          hash_type: sha512

      # ================================================================================================================
      #                                      == Configuration of AHAB SRK table ==
      # ================================================================================================================
      # ---------------------------------===== SRK Table [Conditionally required] =====---------------------------------
      # Description: SRK (Super Root key) table definition.
      srk_table:
        # ----------------------------------------===== CA Flag [Optional] =====----------------------------------------
        # Description: CA Flag is used by HAB to indicate if the SRK is allowed to sign other keys
        flag_ca: false
        # ------------------------------===== Super Root Key (SRK) table [Required] =====-------------------------------
        # Description: Table containing the used SRK records. All SRKs must be of the same type. Supported signing
        # algorithms are: RSA-PSS, ECDSA, Dilithium or SM2. Supported hash algorithms: sha256, sha384, sha512, sha3_256,
        # sha3_384, sha3_512, sm3. Supported key sizes/curves: prime256v1, sec384r1, sec512r1, rsa2048, rsa4096,
        # dilithium3, sm2. Certificate may be of Certificate Authority. Dilithium algorithms are supported just in new
        # type of AHAB container
        srk_array: Define the SRK (Super Root Keys) record. In our case the local pregenerated public keys
          - ../../_data/keys/ecc256/srk0_ecc256.pub
          - ../../_data/keys/ecc256/srk1_ecc256.pub
          - ../../_data/keys/ecc256/srk2_ecc256.pub
          - ../../_data/keys/ecc256/srk3_ecc256.pub

3. Export the AHAB container

To export the AHAB container, SPSDK provides a dedicated tool called ‘nxpimage’ with a specific sub-command group named ‘ahab’. This tool is designed to efficiently handle the creation and management of AHAB containers, offering a streamlined process for developers working with NXP’s Advanced High-Assurance Boot (AHAB) technology.

# Export AHAB container using nxpimage
%! nxpimage $VERBOSITY ahab export -c $AHAB_CONFIG

assert os.path.exists(AHAB_CONFIG)

nxpimage -v ahab export -c inputs/flashloader_cm33_cfg.yaml 
INFO:spsdk.apps.nxpimage:Created AHAB Image:
Name:      AHAB Image
Starts:    0x0
Ends:      0x19cef
Size:      Size: 103.2 kiB; 105,712 B
Alignment: 8 B
Pattern:zeros
AHAB Image for mimxrt1189_b0

INFO:spsdk.apps.nxpimage:Created AHAB Image memory map:

+==0x0000_0000= AHAB Image =======================+
|           Size: 103.2 kiB; 105,712 B            |
|          AHAB Image for mimxrt1189_b0           |
|                 Pattern: zeros                  |
|+==0x0000_0000= AHAB Containers ================+|
||            Size: 8.0 kiB; 8,192 B             ||
||             AHAB Containers block             ||
||                Pattern: zeros                 ||
||+==0x0000_0000= AHAB Container 0 =============+||
|||                 Size: 544 B                 |||
|||       AHAB Container for nxp_SWver:0        |||
||+==0x0000_021f================================+||
||                  Gap: 480 B                   ||
||+==0x0000_0400= AHAB Container 1 =============+||
|||                 Size: 544 B                 |||
|||       AHAB Container for oem_SWver:0        |||
||+==0x0000_061f================================+||
|+==0x0000_1fff==================================+|
|+==0x0000_2000= Container 0 AHAB Data Image 0 ==+|
||            Size: 9.2 kiB; 9,456 B             ||
||AHAB encrypted data block for ele core and ele ||
||                  Image Type.                  ||
|+==0x0000_44ef==================================+|
|+==0x0000_44f0= Container 1 AHAB Data Image 0 ==+|
||           Size: 86.0 kiB; 88,064 B            ||
||    AHAB data block for cortex-m33 core and    ||
||            executable Image Type.             ||
|+==0x0001_9cef==================================+|
+==0x0001_9cef====================================+

Success. (AHAB: workspace\flashloader_cm33_ahab.bin created.)
Generated file containing SRK hash: workspace\flashloader_cm33_ahab_oem1_srk0_hash.txt
INFO:spsdk.image.ahab.utils:
Fuses info:

 --== Grouped register name: SRKH ==-- 
OTP ID: 128, Value: 0x74c72ccb
OTP ID: 129, Value: 0x92ecdcb2
OTP ID: 130, Value: 0xa0ec40c8
OTP ID: 131, Value: 0xf8786b64
OTP ID: 132, Value: 0x3a1d66d3
OTP ID: 133, Value: 0x5a26ed43
OTP ID: 134, Value: 0xac130a49
OTP ID: 135, Value: 0xa195ea7

Generated script for writing fuses for container 1: workspace\flashloader_cm33_ahab_oem1_srk0_hash_blhost.bcf

4. Create a Bootable Image

To properly load the created flashloader over serial downloader mode, a bootable image must be created. In the case of serial downloader, the bootable image is composed of an optional XMCD block (up to 1KB, 0x400B) and the AHAB image itself.

nxpimage bootable-image get-templates -f mimxrt1189 -o workspace/bootable_image_templates --force
Creating workspace/bootable_image_templates/bootimg_mimxrt1189_serial_downloader.yaml template file.
Creating workspace/bootable_image_templates/bootimg_mimxrt1189_flexspi_nor.yaml template file.
Creating workspace/bootable_image_templates/bootimg_mimxrt1189_flexspi_nand.yaml template file.
Creating workspace/bootable_image_templates/bootimg_mimxrt1189_semc_nand.yaml template file.
Creating workspace/bootable_image_templates/bootimg_mimxrt1189_emmc.yaml template file.
Creating workspace/bootable_image_templates/bootimg_mimxrt1189_sd.yaml template file.

Configuration Differences

Show Diff Download Config

# ====================  Bootable Image Configuration template for mimxrt1189 / Serial downloader.  =====================

# ======================================================================================================================
#                                                 == General Options ==                                                 
# ======================================================================================================================
# -------------------------------------===== The chip family name [Required] =====--------------------------------------
# Description: NXP chip family identifier.
# Possible options: 
# lpc5528, lpc5534, lpc5536, lpc55s04, lpc55s06, lpc55s14, lpc55s16, lpc55s26, lpc55s28, lpc55s36, lpc55s66, lpc55s69,
# mc56f81646, mc56f81648, mc56f81666, mc56f81668, mc56f81746, mc56f81748, mc56f81766, mc56f81768, mcxa132, mcxa133,
# mcxa142, mcxa143, mcxa144, mcxa145, mcxa146, mcxa152, mcxa153, mcxa154, mcxa155, mcxa156, mcxn235, mcxn236, mcxn546,
# mcxn547, mcxn946, mcxn947, mcxw716a, mcxw716c, mimx8ulp, mimx9131, mimx9352, mimx9596, mimxrt1010, mimxrt1015,
# mimxrt1020, mimxrt1024, mimxrt1040, mimxrt1050, mimxrt1060, mimxrt1064, mimxrt1165, mimxrt1166, mimxrt1171,
# mimxrt1172, mimxrt1173, mimxrt1175, mimxrt1176, mimxrt1181, mimxrt1182, mimxrt1187, mimxrt1189, mimxrt533s,
# mimxrt555s, mimxrt595s, mimxrt685s, mimxrt798s, mwct2012, mwct2012a, nhs52s04, rw610, rw612>
family: mimxrt1189
# -----------------------------------------===== MCU revision [Optional] =====------------------------------------------
# Description: Revision of silicon. The 'latest' name, means most current revision.
# Possible options: 
revision: latest
# ------------------------------------------===== Memory type [Required] =====------------------------------------------
# Description: Specify type of memory used by bootable image description.
memory_type: serial_downloader
# ----------------------------------------===== Initial segment [Optional] =====----------------------------------------
# Description: The segment name or the index of initial segment in exported image
init_offset: 0 This might be removed
# ======================================================================================================================
#                                           == Bootable Segments definition ==                                          
# ======================================================================================================================
# ----------------------------------------===== XMCD block path [Optional] =====----------------------------------------
# Description: External Memory Configuration Data Segment Image path. It could be used as pre-prepared binary form of
# XMCD and also YAML configuration file for XMCD. In case that YAML configuration file is used, the Bootable image tool
# build the XMCD itself.
xmcd: xmcd.bin Remove XMCD block section from configuration file (no custom XMCD will be used)
# ======================================================================================================================
#                                          == Executable Segment definition ==                                          
# ======================================================================================================================
# ----------------------------------------===== AHAB container [Optional] =====-----------------------------------------
# Description: AHAB container image path. It could be used as pre-prepared binary form of AHAB and also YAML
# configuration file for AHAB. In case that YAML configuration file is used, the Bootable image tool build the AHAB
# itself.
ahab_container: ahab_container.yaml Specify the path to the AHAB container generated in the previous step
ahab_container: ../workspace/flashloader_cm33_ahab.bin

# Copyright 2024 NXP
#
# SPDX-License-Identifier: BSD-3-Clause
# ================================  Bootable Image Configuration template for mimxrt1189.  =================================

# ======================================================================================================================
#                                                 == General Options ==
# ======================================================================================================================
# ------------------------------------------===== MCU family [Required] =====-------------------------------------------
# Description: MCU family name.
# Possible options: 
family: mimxrt1189
# -------------------------------------===== Chip silicon revision [Optional] =====-------------------------------------
# Description: If needed this could be used to specify silicon revision of device.
# Possible options: 
revision: latest
# ------------------------------------------===== Memory type [Required] =====------------------------------------------
# Description: Specify type of memory used by bootable image description.
# Possible options: 
memory_type: serial_downloader
# ======================================================================================================================
#                                          == Executable Segment definition ==
# ======================================================================================================================
# ----------------------------------------===== AHAB container [Required] =====-----------------------------------------
# Description: AHAB container image path. It could be used as pre-prepared binary form of AHAB and also YAML
# configuration file for AHAB. In case that YAML configuration file is used, the Bootable image tool build the AHAB
# itself.
ahab_container: ../workspace/flashloader_cm33_ahab.bin

4.1 Export the final bootable image

# Export bootable image

%! nxpimage $VERBOSITY bootable-image merge -c $BOOTIMG_CONFIG -o $FLASHLOADER

assert os.path.exists(FLASHLOADER)

nxpimage -v bootable-image merge -c inputs/bootimg_rt118x_serial_downloader.yaml -o workspace/flashloader.bin 
INFO:spsdk.apps.nxpimage:Created Bootable Image:
Name:      Bootable Image for mimxrt1189
Starts:    0x0
Ends:      0x1a0ef
Size:      Size: 104.2 kiB; 106,736 B
Alignment: 1 B
Pattern:zeros
Memory type: MemoryType.SERIAL_DOWNLOADER
Revision: latest

INFO:spsdk.apps.nxpimage:Created Bootable Image memory map:

+==0x0000_0000= Bootable Image for mimxrt1189 ==+
|          Size: 104.2 kiB; 106,736 B           |
|   Memory type: MemoryType.SERIAL_DOWNLOADER   |
|               Revision: latest                |
|                Pattern: zeros                 |
|                 Gap: 1.0 kiB                  |
|+==0x0000_0400= ahab_container ===============+|
||         Size: 103.2 kiB; 105,712 B          ||
|+==0x0001_a0ef================================+|
+==0x0001_a0ef==================================+

Success. (Bootable Image: workspace\flashloader.bin created) 

5. Generated flashloader file load to i.MXRT118x

As the final step, load the flashloader into the MCU and run it. The easiest way to do this is by using the ‘blhost’ application with the ‘load-image’ command.

Ensure that the chip is in serial downloader mode!

Here are two examples of how to do this over a Serial line or USB:

• blhost -p com1 load-image workspace/flashloader.bin

• blhost -u 0x1fc9:0x014c load-image workspace/flashloader.bin