21.13.1.26 mss_add_register

Description

This tcl command records whenever registers are selected in the tool.

mss_add_register -reg_name {register name} -reset {0|1}

Arguments

ParameterTypeDescription

deviceName

string

Optional user-defined device name. The device name is not required if there is only one device in the current configuration, or a device has already been selected using the set_debug_device command.

reg_name

string

Specifies name of the register.

reset

boolean

When set to 1, all the previously selected registers will be cleared from the list and the new ones will be added. If 0, then adds the register to the old list.

Return TypeDescription
NoneNone

Error Codes

Error CodeDescription

None

Enter register names and reset value. Params are "reg_name" and "reset".

None

Parameter 'reg_name' has illegal value.

None

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

None

Parameter 'reset' has illegal value.

None

reset: Invalid argument value: '' (expecting TRUE, 1, true, FALSE, 0 or false).

None

Parameter 'param_name' is not defined. Valid command formatting is'mss_add_register [-deviceName "device name"] \[-reg_name "Add Register Names"]* \[-reset "TRUE | FALSE"]'.

Supported Families

PolarFire SoC

Example

This example adds the following registers into mss register list.

mss_add_register \
-reg_name {ATHENA:CSRMAIN} \
-reg_name {ATHENA:CSRMERRS} \
-reg_name {ATHENA:CSRMERRT0} \
-reg_name {ATHENA:CSRMERRT1} \
-reg_name {ATHENA:CSRMERRV} \
-reset 0

See Also

  • mss_read_register

  • mss_write_register​

  • mss_export_register​