21.10.18 set_cipher_text_auth_client

Description

This Tcl command is added to the sNVM.cfg file that is given as the parameter to the configure_snvm command. Cipher-text Authenticated clients have 236 bytes available for user data in each page of sNVM.

set_cipher_text_auth_client \
              -client_name {name} \
              -number_of_bytes {number} \
              -content_type {MEMORY_FILE | STATIC_FILL} \
              -content_file_format {Microchip-Binary 8/16/32 bit} \
              -content_file {path} \
              -start_page {number} \
              -use_for_simulation {0} \
              -reprogram {0 | 1} \
              -use_as_rom {0 | 1}

Arguments


Parameter	Type	Description
client_name	string	The name of the client. Needs to start with an alphabetic letter. Underscores and numerals are allowed at all positions other than the first.
number_of_bytes	integer	The size of the client specified in bytes.
content_type	string	Source of data for the client. This can either be a memory file or all zeros. Allowed values are MEMORY_FILE or STATIC_FILL.
content_file_format	string	Only ‘Microchip-Binary 8/16/32 bit’ is supported at this time.
content_file	string	Path of the memory file. This can be absolute or relative to the project.
start_page	integer	The page number in sNVM where data for this client will be placed.
use_for_simulation	integer	Only value 0 is allowed.
reprogram	boolean	Specifies whether the client will be programmed into the final design or not. Possible values are 0 or 1.
use_as_rom	boolean	Specifies whether the client will allow only reads or both read and writes. Possible values are 0 or 1.


Return Type	Description
None	None

Error Codes


Error Code	Description
None	None

Supported Families


PolarFire®
PolarFire SoC

Example

The following example adds CipherText Authenticated client:

set_cipher_text_auth_client \
        -client_name {client1}  \
        -number_of_bytes 5 \
        -content_type {STATIC_FILL}  \
        -content_file_format {Microchip-Binary 8/16/32 bit}  \
        -content_file {}  \
        -mem_file_base_address {0x00000000}  \
        -start_page 100 \
        -use_for_simulation 0 \
        -reprogram 0 \
        -use_as_rom 1