This section defines the virtual field and callback classes.
A virtual field is set of contiguous bits in one or more memory locations. The semantics and layout of virtual fields comes from an agreement between the software and the hardware, not any physical structures in the DUT.
| Virtual Register Field Classes | This section defines the virtual field and callback classes. |
| uvm_vreg_field | Virtual field abstraction class |
| uvm_vreg_field_cbs | Pre/post read/write callback facade class |
Virtual field abstraction class
A virtual field represents a set of adjacent bits that are logically implemented in consecutive memory locations.
| uvm_vreg_field | ||||
| Virtual field abstraction class | ||||
| Class Hierarchy | ||||
| ||||
| Class Declaration | ||||
| ||||
| initialization | ||||
| new | Create a new virtual field instance | |||
| configure | Instance-specific configuration | |||
| Introspection | ||||
| get_name | Get the simple name | |||
| get_full_name | Get the hierarchical name | |||
| get_parent | Get the parent virtual register | |||
| get_lsb_pos_in_register | Return the position of the virtual field / Returns the index of the least significant bit of the virtual field in the virtual register that instantiates it. | |||
| get_n_bits | Returns the width, in bits, of the virtual field. | |||
| get_access | Returns the access policy of the virtual field register when written and read via an address map. | |||
| HDL Access | ||||
| write | Write the specified value in a virtual field | |||
| read | Read the current value from a virtual field | |||
| poke | Deposit the specified value in a virtual field | |||
| peek | Sample the current value from a virtual field | |||
| Callbacks | ||||
| pre_write | Called before virtual field write. | |||
| post_write | Called after virtual field write | |||
| pre_read | Called before virtual field read. | |||
| post_read | Called after virtual field read. | |||
function new( string name = "uvm_vreg_field" )
Create a new virtual field instance
This method should not be used directly. The uvm_vreg_field::type_id::create() method should be used instead.
function void configure( uvm_vreg parent, int unsigned size, int unsigned lsb_pos )
Instance-specific configuration
Specify the parent virtual register of this virtual field, its size in bits, and the position of its least-significant bit within the virtual register relative to the least-significant bit of the virtual register.
Get the simple name
Return the simple object name of this virtual field
virtual function string get_full_name()
Get the hierarchical name
Return the hierarchal name of this virtual field The base of the hierarchical name is the root block.
virtual function int unsigned get_lsb_pos_in_register()
Return the position of the virtual field / Returns the index of the least significant bit of the virtual field in the virtual register that instantiates it. An offset of 0 indicates a field that is aligned with the least-significant bit of the register.
virtual function int unsigned get_n_bits()
Returns the width, in bits, of the virtual field.
virtual function string get_access( uvm_reg_map map = null )
Returns the access policy of the virtual field register when written and read via an address map.
If the memory implementing the virtual field is mapped in more than one address map, an address map must be specified. If access restrictions are present when accessing a memory through the specified address map, the access mode returned takes the access restrictions into account. For example, a read-write memory accessed through an address map with read-only restrictions would return “RO”.
virtual task write( input longint unsigned idx, output uvm_status_e status, input uvm_reg_data_t value, input uvm_path_e path = UVM_DEFAULT_PATH, input uvm_reg_map map = null, input uvm_sequence_base parent = null, input uvm_object extension = null, input string fname = "", input int lineno = 0 )
Write the specified value in a virtual field
Write value in the DUT memory location(s) that implements the virtual field that corresponds to this abstraction class instance using the specified access path.
If the memory implementing the virtual register array containing this virtual field is mapped in more than one address map, an address map must be specified if a physical access is used (front-door access).
The operation is eventually mapped into memory read-modify-write operations at the location where the virtual register specified by idx in the virtual register array is implemented. If a backdoor is available for the memory implemeting the virtual field, it will be used for the memory-read operation.
virtual task read( input longint unsigned idx, output uvm_status_e status, output uvm_reg_data_t value, input uvm_path_e path = UVM_DEFAULT_PATH, input uvm_reg_map map = null, input uvm_sequence_base parent = null, input uvm_object extension = null, input string fname = "", input int lineno = 0 )
Read the current value from a virtual field
Read from the DUT memory location(s) that implements the virtual field that corresponds to this abstraction class instance using the specified access path, and return the readback value.
If the memory implementing the virtual register array containing this virtual field is mapped in more than one address map, an address map must be specified if a physical access is used (front-door access).
The operation is eventually mapped into memory read operations at the location(s) where the virtual register specified by idx in the virtual register array is implemented.
virtual task poke( input longint unsigned idx, output uvm_status_e status, input uvm_reg_data_t value, input uvm_sequence_base parent = null, input uvm_object extension = null, input string fname = "", input int lineno = 0 )
Deposit the specified value in a virtual field
Deposit value in the DUT memory location(s) that implements the virtual field that corresponds to this abstraction class instance using the specified access path.
The operation is eventually mapped into memory peek-modify-poke operations at the location where the virtual register specified by idx in the virtual register array is implemented.
virtual task peek( input longint unsigned idx, output uvm_status_e status, output uvm_reg_data_t value, input uvm_sequence_base parent = null, input uvm_object extension = null, input string fname = "", input int lineno = 0 )
Sample the current value from a virtual field
Sample from the DUT memory location(s) that implements the virtual field that corresponds to this abstraction class instance using the specified access path, and return the readback value.
If the memory implementing the virtual register array containing this virtual field is mapped in more than one address map, an address map must be specified if a physical access is used (front-door access).
The operation is eventually mapped into memory peek operations at the location(s) where the virtual register specified by idx in the virtual register array is implemented.
virtual task pre_write( longint unsigned idx, ref uvm_reg_data_t wdat, ref uvm_path_e path, ref uvm_reg_map map )
Called before virtual field write.
If the specified data value, access path or address map are modified, the updated data value, access path or address map will be used to perform the virtual register operation.
The virtual field callback methods are invoked before the callback methods on the containing virtual register. The registered callback methods are invoked after the invocation of this method. The pre-write virtual register and field callbacks are executed before the corresponding pre-write memory callbacks
virtual task post_write( longint unsigned idx, uvm_reg_data_t wdat, uvm_path_e path, uvm_reg_map map, ref uvm_status_e status )
Called after virtual field write
If the specified status is modified, the updated status will be returned by the virtual register operation.
The virtual field callback methods are invoked after the callback methods on the containing virtual register. The registered callback methods are invoked before the invocation of this method. The post-write virtual register and field callbacks are executed after the corresponding post-write memory callbacks
virtual task pre_read( longint unsigned idx, ref uvm_path_e path, ref uvm_reg_map map )
Called before virtual field read.
If the specified access path or address map are modified, the updated access path or address map will be used to perform the virtual register operation.
The virtual field callback methods are invoked after the callback methods on the containing virtual register. The registered callback methods are invoked after the invocation of this method. The pre-read virtual register and field callbacks are executed before the corresponding pre-read memory callbacks
virtual task post_read( longint unsigned idx, ref uvm_reg_data_t rdat, uvm_path_e path, uvm_reg_map map, ref uvm_status_e status )
Called after virtual field read.
If the specified readback data rdat or status is modified, the updated readback data or status will be returned by the virtual register operation.
The virtual field callback methods are invoked after the callback methods on the containing virtual register. The registered callback methods are invoked before the invocation of this method. The post-read virtual register and field callbacks are executed after the corresponding post-read memory callbacks
Pre/post read/write callback facade class
| uvm_vreg_field_cbs | |||||
| Pre/post read/write callback facade class | |||||
| Class Hierarchy | |||||
| |||||
| Class Declaration | |||||
| |||||
| Methods | |||||
| pre_write | Callback called before a write operation. | ||||
| post_write | Called after a write operation | ||||
| pre_read | Called before a virtual field read. | ||||
| post_read | Called after a virtual field read. | ||||
| Types | |||||
| uvm_vreg_field_cb | Convenience callback type declaration | ||||
| uvm_vreg_field_cb_iter | Convenience callback iterator type declaration | ||||
virtual task pre_write( uvm_vreg_field field, longint unsigned idx, ref uvm_reg_data_t wdat, ref uvm_path_e path, ref uvm_reg_map map )
Callback called before a write operation.
The registered callback methods are invoked before the invocation of the virtual register pre-write callbacks and after the invocation of the uvm_vreg_field::pre_write() method.
The written value wdat, access path and address map, if modified, modifies the actual value, access path or address map used in the register operation.
virtual task post_write( uvm_vreg_field field, longint unsigned idx, uvm_reg_data_t wdat, uvm_path_e path, uvm_reg_map map, ref uvm_status_e status )
Called after a write operation
The registered callback methods are invoked after the invocation of the virtual register post-write callbacks and before the invocation of the uvm_vreg_field::post_write() method.
The status of the operation, if modified, modifies the actual returned status.
virtual task pre_read( uvm_vreg_field field, longint unsigned idx, ref uvm_path_e path, ref uvm_reg_map map )
Called before a virtual field read.
The registered callback methods are invoked after the invocation of the virtual register pre-read callbacks and after the invocation of the uvm_vreg_field::pre_read() method.
The access path and address map, if modified, modifies the actual access path or address map used in the register operation.
virtual task post_read( uvm_vreg_field field, longint unsigned idx, ref uvm_reg_data_t rdat, uvm_path_e path, uvm_reg_map map, ref uvm_status_e status )
Called after a virtual field read.
The registered callback methods are invoked after the invocation of the virtual register post-read callbacks and before the invocation of the uvm_vreg_field::post_read() method.
The readback value rdat and the status of the operation, if modified, modifies the actual returned readback value and status.
Convenience callback type declaration
Use this declaration to register virtual field callbacks rather than the more verbose parameterized class
Convenience callback iterator type declaration
Use this declaration to iterate over registered virtual field callbacks rather than the more verbose parameterized class
Virtual field abstraction class
class uvm_vreg_field extends uvm_object
Pre/post read/write callback facade class
class uvm_vreg_field_cbs extends uvm_callback
The uvm_object class is the base class for all UVM data and hierarchical classes.
virtual class uvm_object extends uvm_void
Create a new virtual field instance
function new( string name = "uvm_vreg_field" )
Instance-specific configuration
function void configure( uvm_vreg parent, int unsigned size, int unsigned lsb_pos )
Get the hierarchical name
virtual function string get_full_name()
Get the parent virtual register
virtual function uvm_vreg get_parent()
Return the position of the virtual field / Returns the index of the least significant bit of the virtual field in the virtual register that instantiates it.
virtual function int unsigned get_lsb_pos_in_register()
Returns the width, in bits, of the virtual field.
virtual function int unsigned get_n_bits()
Returns the access policy of the virtual field register when written and read via an address map.
virtual function string get_access( uvm_reg_map map = null )
Write the specified value in a virtual field
virtual task write( input longint unsigned idx, output uvm_status_e status, input uvm_reg_data_t value, input uvm_path_e path = UVM_DEFAULT_PATH, input uvm_reg_map map = null, input uvm_sequence_base parent = null, input uvm_object extension = null, input string fname = "", input int lineno = 0 )
Read the current value from a virtual field
virtual task read( input longint unsigned idx, output uvm_status_e status, output uvm_reg_data_t value, input uvm_path_e path = UVM_DEFAULT_PATH, input uvm_reg_map map = null, input uvm_sequence_base parent = null, input uvm_object extension = null, input string fname = "", input int lineno = 0 )
Deposit the specified value in a virtual field
virtual task poke( input longint unsigned idx, output uvm_status_e status, input uvm_reg_data_t value, input uvm_sequence_base parent = null, input uvm_object extension = null, input string fname = "", input int lineno = 0 )
Sample the current value from a virtual field
virtual task peek( input longint unsigned idx, output uvm_status_e status, output uvm_reg_data_t value, input uvm_sequence_base parent = null, input uvm_object extension = null, input string fname = "", input int lineno = 0 )
Called before virtual field write.
virtual task pre_write( longint unsigned idx, ref uvm_reg_data_t wdat, ref uvm_path_e path, ref uvm_reg_map map )
Called after virtual field write
virtual task post_write( longint unsigned idx, uvm_reg_data_t wdat, uvm_path_e path, uvm_reg_map map, ref uvm_status_e status )
Called before virtual field read.
virtual task pre_read( longint unsigned idx, ref uvm_path_e path, ref uvm_reg_map map )
Called after virtual field read.
virtual task post_read( longint unsigned idx, ref uvm_reg_data_t rdat, uvm_path_e path, uvm_reg_map map, ref uvm_status_e status )
The uvm_callback class is the base class for user-defined callback classes.
class uvm_callback extends uvm_object
Callback called before a write operation.
virtual task pre_write( uvm_vreg_field field, longint unsigned idx, ref uvm_reg_data_t wdat, ref uvm_path_e path, ref uvm_reg_map map )
Called after a write operation
virtual task post_write( uvm_vreg_field field, longint unsigned idx, uvm_reg_data_t wdat, uvm_path_e path, uvm_reg_map map, ref uvm_status_e status )
Called before a virtual field read.
virtual task pre_read( uvm_vreg_field field, longint unsigned idx, ref uvm_path_e path, ref uvm_reg_map map )
Called after a virtual field read.
virtual task post_read( uvm_vreg_field field, longint unsigned idx, ref uvm_reg_data_t rdat, uvm_path_e path, uvm_reg_map map, ref uvm_status_e status )