21.13.1.28 mss_write_register

Description

This tcl command writes value to the selected registers.

If there is a conflict in the values where full register write values and also field values of the same register, then a full register write is executed and field write will be ignored.

mss_write_register [-deviceName "device name"] \[-reg_name "Register Name"]* \[-value "Register write value"]* \[-axiQos "integer 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

Name of the register according to the hierarchy seen in the UI separated by colon. It can also contain register field separated by colon.

value

hexadecimal

Hexadecimal value - ranges from 1-bit to 64-bits.

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
NoneNone

Error Codes

Error CodeDescription

None

Can not write into a read-only register or a field.

None

Invalid register name specified.

None

Parameter 'reg_name' has illegal value.

None

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

None

Invalid register value specified.

None

Parameter 'value' has illegal value.

None

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

Supported Families

PolarFire SoC

Example

This example writes the values into the registers.

mss_write_register \
    -reg_name {MMUART0_LO:RBR} -value {0x123} \
    -reg_name {MMUART0_LO:IER} -value {0xFFFFFFFF} \
    -reg_name {MMUART0_LO:IIR:IIR} -value {0x3}

See Also

  • mss_read_register

  • mss_export_register

  • mss_add_register