21.10.22 set_client

Description

Use the following Tcl command to specify the client that will be added to the SPI Flash memory configuration file along with the configure_spiflash command.

set_client -client_name {client name} \
           -client_type {FILE_SPI | FILE_SPI_GOLDEN | FILE_SPI_UPDATE | FILE_DATA_STORAGE_INTELHEX} \
           -content_type {MEMORY_FILE | STATIC_FILL} \
           -content_file {} \
           -start_address {} \
           -client_size {} \
           -program {0|1}

Use the following Tcl command to specify the client that will be added to the fabric RAM configuration file along with the configure_ram command.

set_client \
   -logical_instance_name  {RAM user defined instance name}  \
   -storage_type { Initialization client storage type}  \
   -content_type { NO_CONTENT | MEMORY_FILE } \
   -memory_file_format { Intel-Hex | Motorola-S | Simple-Hex | Microsemi-Binary}  \
   -memory_file {path}

Arguments


Parameter	Type	Description
client_name	string	The name of the client. Maximum of 32 characters, letters or numbers or “-“ or “_”.
client_type	string	The -client_type can be FILE_SPI, FILE_SPI_GOLDEN, FILE_SPI_UPDATE orFILE_DATA_STORAGE_INTELHEX. FILE_SPI - SPI Bitstream. FILE_SPI_GOLDEN - Recovery/Golden SPI Bitstream. FILE_SPI_UPDATE - Auto Update SPI Bitstream, available only if Auto Update is enabled. See set_auto_update_mode. FILE_DATA_STORAGE_INTELHEX - Data Storage client.
content_type	string	Specifies the type of memory content: MEMORY_FILE - content_file parameter must be specified. STATIC_FILL - client memory will be filled with 1s, no content memory file. NO_CONTENT - no content memory file.
content_file	string	Absolute or relative path to the content memory file.
start_address	integer	The client start address. Note that some space is reserved for the SPI Flash Memory directory. This is a decimal value of bytes.
client_size	integer	Client’s size in bytes. If a content file is specified, the size must be equal to or larger than the file size. This is a decimal value.
program	boolean	Only program \| 1 is supported in this release.
logical_instance_name	string	Specifies the name for the user defined memory instance.
storage_type	string	Specifies storage type to initialize RAM: SNVM UPROM SPI
memory_file_format	string	Specifies the memory file format: Intel-Hex Motorola-S Simple-Hex Microchip-Binary
memory_file	string	Specifies the absolute or relative path of the memory file.


Return Type	Description
None	None

Error Codes


Error Code	Description
None	None

Supported Families


PolarFire®
PolarFire SoC

Example

The following examples show the set_client Tcl command for SPI Flash.

set_client -client_name {golden} \
           -client_type {FILE_SPI_GOLDEN} \
           -content_type {MEMORY_FILE} \
           -content_file {E:\top_design_ver_1.spi} \
           -start_address {1024} \
           -client_size {9508587} \
           -program {1}

set_client -client_name {cl1} \
           -client_type {FILE_DATA_STORAGE_INTELHEX} \
           -content_type {STATIC_FILL} \
           -content_file {} \
           -start_address {1024} \
           -client_size {100} \
           -program {1}

The following examples show the set_client Tcl command for the fabric RAM configuration file.

set_client \
   -logical_instance_name  {PF_TPSRAM_C0_0/PF_TPSRAM_C0_0}  \
   -storage_type {SNVM}  \
   -content_type {MEMORY_FILE}  \
   -memory_file_format {}  \
   -memory_file {Y:/DP_mem/DPRAM_1k_20/hexmod.hex}