The field editor is used to edit the details of a field. For example user may define enumerated values that define the legal bit patterns of the field.
Name is a mandatory identifier for the field. The name must be unique within all the fields of the containing register.
Display name is an optional and used for a more user-friendly identifier.
Description is an optional field for textual description of the field.
Offset is mandatory and describes the starting bit of the field within the containing register.
Width is mandatory and speficies how many bits are included in the field.
Is present is optional and enables/disables a field presence in a register. Value 1 indicates that the field is present in the register whereas value 0 marks the field to be treated as if it does not exist. Is present can be given as a SystemVerilog expression, but it must evaluate to 1 or 0.
Reset value is optional and defines the actual reset value on reset. Reset value uses SystemVerilog syntax for binary values. The number of bits must be equal to the field size.
Reset mask is optional and defines the bits that have a known reset value. Bit value of 1 means that the corresponding bit has a known reset value whereas 0 means that the value is unknown. Reset mask uses SystemVerilog syntax for binary values e.g. 'b1011, 4'b1011, and 4'b10_11 are all valid values. The number of bits must be equal to the field size.
Volatile is optional and indicates that the field may change its value without write operations.
Access is optional and specifies the accessability of the field. The possible values are:
Modified write value is optional and describes how the data in the field is manipulated on a write operation. The basic operation without any setting is to store the written value 'as is'. Moreover, both bitwise and field-wise set/clear/toggle is also possible. The possible values are:
Read action is optional and specifies if some action happens to the field after a read operation. By default the field is unmodified. The possible values are:
Testable is optional and specifies if the field is testable by an automated register test.
Test constraint is optional and specifies the constaints for the automated tests for the field. The possible values are:
The write value constraints are used to define what are the legal values user may write to a field. The possible values are:
The enumerated values table enables the defining of bit patterns that can be identified by a name. This can be used to define the legal bit patterns for a field or to define some default settings to help configuration of the field.
Each enumeration contains a unique name of the enumeration (mandatory), an optional display name and description.
Value defines the value to assign to the specified name (mandatory).
Usage defines the software access condition under which this name value pair is valid. Possible values are: read, write and read-write.