21.13.1.27 mss_read_register

Description

This tcl command reads all selected registers by their register names and displays the values. The values are in hexadecimal format.

mss_read_register [-deviceName "device name"]  \
                  [-reg_name {register name}"] \
                  [-axiQos "interger value"] \
                  [-axiProt "integer value"] \
                  [-axiCache "integer value"] \
                  [-axiLock "integer value"] \
                  [-silent "TRUE | FALSE"]

Arguments

ParameterTypeDescription

deviceName

string

Specify device name. This parameter is optional if only one device is available in the current configuration.

reg_name

string

This is an optional argument, that specifies the name of the register according to the hierarchy seen in the UI separated by colon.

axiQos

integer

This is an optional parameter that specifies the value of the attribute QoS on Axi interface.

axiCache

integer

This is an optional parameter that specifies the value of the attribute Cache on Axi interface.

axiProt

integer

This is an optional parameter that specifies the value of the attribute Protocol on Axi interface.

axiLock

integer

This is an optional parameter that specifies the value of the attribute Lock on Axi interface.

Return TypeDescription
HexadecimalReads all selected registers by their register names and displays the values.

Error Codes

Error CodeDescription

None

Register is not found in the valid list provided in pfsoc_regmap.htm file.

None

Parameter 'reg_name' has illegal value.

None

Parameter 'param_name' is not defined. Valid command formatting is'mss_read_register [-deviceName "device name"] \[-reg_name "Register Name"]* \[-axiQos "integer value"] \[-axiProt "integer value"] \[-axiCache "integer value"] \[-axiLock "integer value"] \[-silent "TRUE | FALSE"]'.

Supported Families

PolarFire SoC

Example

Read register with parameters. Read with {ATHENA:CSRMAIN} and {ATHENA:CSRMERRS} registers:

mss_read_register \
    -reg_name {ATHENA:CSRMAIN} \
    -reg_name {ATHENA:CSRMERRS} 

Register read without parameters (reads all the selected registers that are added using mss_add_register command):

mss_read_register

See Also

  • mss_write_register

  • mss_export_register

  • mss_add_register