Bee for mimxrt1020, Revision: a0

Type: object

root family

The chip family name

Type: enum (of string)

NXP chip family identifier.

Must be one of:

  • "mimxrt1015"
  • "mimxrt1020"
  • "mimxrt1024"
  • "mimxrt1040"
  • "mimxrt1043"
  • "mimxrt1046"
  • "mimxrt1050"
  • "mimxrt1060"
  • "mimxrt1064"
  • "rt1015"
  • "rt102x"
  • "rt104x"
  • "rt105x"
  • "rt106x"

root revision

MCU revision

Type: enum (of string)

Revision of silicon. The 'latest' name, means most current revision.

Must be one of:

  • "a0"
  • "latest"

root output_folder

BEE output folder

Type: string

Folder name to store generated BEE output

root output_name

Output binary file name

Type: string

File name of the encrypted file, outputfolder/outputname or full path (.bin will be appended)

root header_name

File name of the exported BEE region headers

Type: string

outputfolder/headername or full path + index will be appended (.bin will be appended)

root data_blobs

Data blobs list

Type: array of object

List of all data blobs to be encrypted

 No Additional Items

Each item of this array must be:

root data_blobs data_blobs items
Type: object

root data_blobs data_blobs items data

Plain Text data blob

Type: stringFormat: file

Path to binary file with plain text data to be encrypted

root data_blobs data_blobs items address

Data blob address

Type: number or stringFormat: number

Data blob address where the data should be loaded

root engine_selection

Engine selection

Type: enum (of string)

BEE Engine Selection, engine0, engine1 or both engines

Must be one of:

  • "engine0"
  • "engine1"
  • "both"

root engine_key_selection

Engine Key selection (deprecated)

Type: enum (of string)

Deprecated. Use enginekey, engineiv and enginecounter fields in beecfg to specify keys explicitly. If not specified, random keys are generated and saved to output folder.

Must be one of:

  • "random"
  • "zero"

root bee_engine

Bee engines

Type: array

Configuration of BEE engines

Must contain a minimum of 1 items

Must contain a maximum of 2 items

No Additional Items

Each item of this array must be:

root bee_engine bee_engine items

root bee_engine bee_engine items oneOf Engine Config

Engine Config

Type: object

BEE engine configuration

root bee_engine bee_engine items oneOf Engine Config bee_cfg
Type: object

root bee_engine bee_engine items oneOf Engine Config bee_cfg user_key

User AES-128 key

Type: stringFormat: file-or-hex-value

AES key for encryption (sw_key burned into fuses). Could be defined as hex value or path to a binary file.

root bee_engine bee_engine items oneOf Engine Config bee_cfg engine_key

Engine AES-128 KIB key

Type: stringFormat: file-or-hex-value

Optional AES-128 key used to encrypt PRDB in BEE header (CBC mode). If not provided, a random key is generated and saved to output folder. To reuse a previously generated key, provide the value from the saved key file. Could be defined as hex value or path to a binary file.

root bee_engine bee_engine items oneOf Engine Config bee_cfg engine_iv

Engine AES-128 KIB initialization vector

Type: stringFormat: file-or-hex-value

Optional AES-128 initialization vector for PRDB encryption (CBC mode). If not provided, a random IV is generated and saved to output folder. Could be defined as hex value or path to a binary file.

root bee_engine bee_engine items oneOf Engine Config bee_cfg engine_counter

Engine AES-CTR counter (12 bytes)

Type: stringFormat: file-or-hex-value

Optional 12-byte nonce for AES-CTR data encryption. The last 4 bytes (block counter) are always set to zero automatically. If not provided, a random counter is generated and saved to output folder. Could be defined as hex value or path to a binary file.

root bee_engine bee_engine items oneOf Engine Config bee_cfg protected_region

Protected region

Type: array of object

List of protected regions, up to four regions

 No Additional Items

Each item of this array must be:

root bee_engine bee_engine items oneOf Engine Config bee_cfg protected_region protected_region items
Type: object

root bee_engine bee_engine items oneOf Engine Config bee_cfg protected_region protected_region items start_address

Start address of protected region

Type: string or numberFormat: number

Start address of protected region, it should be aligned to 1 KB (1024 B)

root bee_engine bee_engine items oneOf Engine Config bee_cfg protected_region protected_region items length

Length of protected region

Type: string or numberFormat: number

Length of protected region, it should be aligned to 1 KB (1024 B)

root bee_engine bee_engine items oneOf Engine Config bee_cfg protected_region protected_region items protected_level

Protected level

Type: numberFormat: number

Protected level (0/1/2/3), 0 is default
root bee_engine bee_engine items oneOf Engine BinConfig

Engine BinConfig

Type: object

BEE engine configuration with binary header

root bee_engine bee_engine items oneOf Engine BinConfig bee_binary_cfg
Type: object

root bee_engine bee_engine items oneOf Engine BinConfig bee_binary_cfg header_path

BEE header path

Type: string

Path to the existing BEE header in binary form

root bee_engine bee_engine items oneOf Engine BinConfig bee_binary_cfg user_key

User AES-128 key

Type: stringFormat: file-or-hex-value

AES key that was used for header encryption. Could be defined as hex value or path to a binary file.