# {py:mod}`pyuvm._reg.uvm_reg`

```{py:module} pyuvm._reg.uvm_reg
```

```{autodoc2-docstring} pyuvm._reg.uvm_reg
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`uvm_reg <pyuvm._reg.uvm_reg.uvm_reg>`
  -
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`__all__ <pyuvm._reg.uvm_reg.__all__>`
  - ```{autodoc2-docstring} pyuvm._reg.uvm_reg.__all__
    :summary:
    ```
* - {py:obj}`logger <pyuvm._reg.uvm_reg.logger>`
  - ```{autodoc2-docstring} pyuvm._reg.uvm_reg.logger
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: pyuvm._reg.uvm_reg.__all__
:value: >
   ['uvm_reg']

```{autodoc2-docstring} pyuvm._reg.uvm_reg.__all__
```

````

````{py:data} logger
:canonical: pyuvm._reg.uvm_reg.logger
:value: >
   'getLogger(...)'

```{autodoc2-docstring} pyuvm._reg.uvm_reg.logger
```

````

`````{py:class} uvm_reg(name='', n_bits: int = 0, has_coverage: int = 0, **kwargs)
:canonical: pyuvm._reg.uvm_reg.uvm_reg

Bases: {py:obj}`pyuvm._s05_base_classes.uvm_object`

````{py:attribute} _max_size
:canonical: pyuvm._reg.uvm_reg.uvm_reg._max_size
:type: typing.ClassVar[int]
:value: >
   0

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._max_size
```

````

````{py:attribute} _reg_registry
:canonical: pyuvm._reg.uvm_reg.uvm_reg._reg_registry
:type: typing.ClassVar[dict[str, pyuvm._reg.uvm_reg.uvm_reg]]
:value: >
   None

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._reg_registry
```

````

````{py:method} configure(blk_parent: pyuvm._reg.uvm_reg_block.uvm_reg_block, regfile_parent: pyuvm._reg.uvm_reg_file.uvm_reg_file = None, hdl_path: str = '', throw_error_on_read: bool = False, throw_error_on_write: bool = False, **kwargs) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.configure

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.configure
```

````

````{py:method} set_offset(map: pyuvm._reg.uvm_reg_map.uvm_reg_map, offset: pyuvm._reg.uvm_reg_model.uvm_reg_addr_t, unmapped: bool = False) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.set_offset

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.set_offset
```

````

````{py:method} _set_parent(blk_parent: pyuvm._reg.uvm_reg_block.uvm_reg_block, regfile_parent: pyuvm._reg.uvm_reg_file.uvm_reg_file) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg._set_parent
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._set_parent
```

````

````{py:method} _add_field(field: pyuvm._reg.uvm_reg_field.uvm_reg_field) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg._add_field

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._add_field
```

````

````{py:method} add_map(map: pyuvm._reg.uvm_reg_map.uvm_reg_map) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.add_map

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.add_map
```

````

````{py:method} _lock_model() -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg._lock_model

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._lock_model
```

````

````{py:method} _unlock_model() -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg._unlock_model

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._unlock_model
```

````

````{py:method} unregister(map: pyuvm._reg.uvm_reg_map.uvm_reg_map) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.unregister
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.unregister
```

````

````{py:method} get_full_name() -> str
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_full_name

````

````{py:method} get_parent() -> pyuvm._reg.uvm_reg_block.uvm_reg_block
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_parent

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_parent
```

````

````{py:method} get_block() -> pyuvm._reg.uvm_reg_block.uvm_reg_block
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_block

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_block
```

````

````{py:method} get_regfile() -> pyuvm._reg.uvm_reg_file.uvm_reg_file
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_regfile

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_regfile
```

````

````{py:method} get_n_maps() -> int
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_n_maps

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_n_maps
```

````

````{py:method} is_in_map(map: pyuvm._reg.uvm_reg_map.uvm_reg_map) -> bool
:canonical: pyuvm._reg.uvm_reg.uvm_reg.is_in_map

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.is_in_map
```

````

````{py:method} get_maps(maps: list[pyuvm._reg.uvm_reg_map.uvm_reg_map]) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_maps

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_maps
```

````

````{py:method} get_local_map(map: pyuvm._reg.uvm_reg_map.uvm_reg_map) -> pyuvm._reg.uvm_reg_map.uvm_reg_map | None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_local_map

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_local_map
```

````

````{py:method} get_default_map() -> pyuvm._reg.uvm_reg_map.uvm_reg_map | None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_default_map

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_default_map
```

````

````{py:method} get_rights(map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None) -> str
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_rights

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_rights
```

````

````{py:method} get_n_bits() -> int
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_n_bits

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_n_bits
```

````

````{py:method} get_n_bytes() -> int
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_n_bytes

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_n_bytes
```

````

````{py:method} get_max_size() -> int
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_max_size
:staticmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_max_size
```

````

````{py:method} get_fields() -> list[pyuvm._reg.uvm_reg_field.uvm_reg_field]
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_fields

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_fields
```

````

````{py:method} get_field_by_name(name: str) -> pyuvm._reg.uvm_reg_field.uvm_reg_field
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_field_by_name
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_field_by_name
```

````

````{py:method} _get_fields_access(map: pyuvm._reg.uvm_reg_map.uvm_reg_map) -> str
:canonical: pyuvm._reg.uvm_reg.uvm_reg._get_fields_access

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._get_fields_access
```

````

````{py:method} get_offset(map: pyuvm._reg.uvm_reg_map.uvm_reg_map) -> pyuvm._reg.uvm_reg_model.uvm_reg_addr_t
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_offset
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_offset
```

````

````{py:method} get_address(map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None) -> pyuvm._reg.uvm_reg_model.uvm_reg_addr_t
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_address

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_address
```

````

````{py:method} get_addresses(map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None) -> tuple[int, list[pyuvm._reg.uvm_reg_model.uvm_reg_addr_t]]
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_addresses

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_addresses
```

````

````{py:method} get_reg_by_full_name(full_name: str) -> pyuvm._reg.uvm_reg.uvm_reg | None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_reg_by_full_name
:staticmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_reg_by_full_name
```

````

````{py:method} set(value: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, fname: str = '', lineno: int = 0) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.set

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.set
```

````

````{py:method} get(fname: str = '', lineno: int = 0) -> pyuvm._reg.uvm_reg_model.uvm_reg_data_t
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get
```

````

````{py:method} get_mirrored_value(fname: str = '', lineno: int = 0) -> int
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_mirrored_value

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_mirrored_value
```

````

````{py:method} needs_update() -> bool
:canonical: pyuvm._reg.uvm_reg.uvm_reg.needs_update
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.needs_update
```

````

````{py:method} reset(kind: str = 'HARD') -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.reset

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.reset
```

````

````{py:method} get_reset(kind: str = 'HARD') -> int
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_reset
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_reset
```

````

````{py:method} has_reset(kind: str = 'HARD', delete: bool = False) -> bool
:canonical: pyuvm._reg.uvm_reg.uvm_reg.has_reset
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.has_reset
```

````

````{py:method} set_reset(value: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, kind: str = 'HARD') -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.set_reset
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.set_reset
```

````

````{py:method} write(value: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, path: pyuvm._reg.uvm_reg_model.uvm_door_e = uvm_door_e.UVM_DEFAULT_DOOR, map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None, parent: pyuvm._s14_15_python_sequences.uvm_sequence_base = None, prior: int = -1, extension: pyuvm._s05_base_classes.uvm_object = None, fname: str = '', lineno: int = 0, **kwargs) -> pyuvm._reg.uvm_reg_model.uvm_status_e
:canonical: pyuvm._reg.uvm_reg.uvm_reg.write
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.write
```

````

````{py:method} read(path: pyuvm._reg.uvm_reg_model.uvm_door_e = uvm_door_e.UVM_DEFAULT_DOOR, map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None, parent: pyuvm._s14_15_python_sequences.uvm_sequence_base = None, prior: int = -1, extension: pyuvm._s05_base_classes.uvm_object = None, fname: str = '', lineno: int = 0, **kwargs) -> tuple[pyuvm._reg.uvm_reg_model.uvm_status_e, pyuvm._reg.uvm_reg_model.uvm_reg_data_t]
:canonical: pyuvm._reg.uvm_reg.uvm_reg.read
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.read
```

````

````{py:method} poke(value: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, kind: str = '', parent: pyuvm._s14_15_python_sequences.uvm_sequence_base = None, extension: pyuvm._s05_base_classes.uvm_object = None, fname: str = '', lineno: int = 0) -> pyuvm._reg.uvm_reg_model.uvm_status_e
:canonical: pyuvm._reg.uvm_reg.uvm_reg.poke
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.poke
```

````

````{py:method} peek(kind: str = '', parent: pyuvm._s14_15_python_sequences.uvm_sequence_base = None, extension: pyuvm._s05_base_classes.uvm_object = None, fname: str = '', lineno: int = 0) -> tuple[pyuvm._reg.uvm_reg_model.uvm_status_e, pyuvm._reg.uvm_reg_model.uvm_reg_data_t]
:canonical: pyuvm._reg.uvm_reg.uvm_reg.peek
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.peek
```

````

````{py:method} update(path: pyuvm._reg.uvm_reg_model.uvm_door_e = uvm_door_e.UVM_DEFAULT_DOOR, map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None, parent: pyuvm._s14_15_python_sequences.uvm_sequence_base = None, prior: int = -1, extension: pyuvm._s05_base_classes.uvm_object = None, fname: str = '', lineno: int = 0) -> pyuvm._reg.uvm_reg_model.uvm_status_e
:canonical: pyuvm._reg.uvm_reg.uvm_reg.update
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.update
```

````

````{py:method} mirror(check: pyuvm._reg.uvm_reg_model.uvm_check_e = uvm_check_e.UVM_NO_CHECK, path: pyuvm._reg.uvm_reg_model.uvm_door_e = uvm_door_e.UVM_DEFAULT_DOOR, map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None, parent: pyuvm._s14_15_python_sequences.uvm_sequence_base = None, prior: int = -1, extension: pyuvm._s05_base_classes.uvm_object = None, fname: str = '', lineno: int = 0) -> pyuvm._reg.uvm_reg_model.uvm_status_e
:canonical: pyuvm._reg.uvm_reg.uvm_reg.mirror
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.mirror
```

````

````{py:method} predict(value: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, be: pyuvm._reg.uvm_reg_model.uvm_reg_byte_en_t = -1, kind: pyuvm._reg.uvm_reg_model.uvm_predict_e = uvm_predict_e.UVM_PREDICT_DIRECT, path: pyuvm._reg.uvm_reg_model.uvm_door_e = uvm_door_e.UVM_FRONTDOOR, map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None, fname: str = '', lineno: int = 0) -> bool
:canonical: pyuvm._reg.uvm_reg.uvm_reg.predict

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.predict
```

````

````{py:method} is_busy() -> bool
:canonical: pyuvm._reg.uvm_reg.uvm_reg.is_busy

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.is_busy
```

````

````{py:method} _set_is_busy(busy: bool) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg._set_is_busy

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._set_is_busy
```

````

````{py:method} _read(path: pyuvm._reg.uvm_reg_model.uvm_door_e = uvm_door_e.UVM_DEFAULT_DOOR, map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None, parent: pyuvm._s14_15_python_sequences.uvm_sequence_base = None, prior: int = -1, extension: pyuvm._s05_base_classes.uvm_object = None, fname: str = '', lineno: int = 0) -> tuple[pyuvm._reg.uvm_reg_model.uvm_status_e, pyuvm._reg.uvm_reg_model.uvm_reg_data_t]
:canonical: pyuvm._reg.uvm_reg.uvm_reg._read
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._read
```

````

````{py:method} _check_access(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item) -> tuple[bool, pyuvm._reg.uvm_reg_map.uvm_reg_map_info | None]
:canonical: pyuvm._reg.uvm_reg.uvm_reg._check_access

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._check_access
```

````

````{py:method} do_check(expected: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, actual: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, map: pyuvm._reg.uvm_reg_map.uvm_reg_map) -> bool
:canonical: pyuvm._reg.uvm_reg.uvm_reg.do_check
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.do_check
```

````

````{py:method} do_write(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.do_write
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.do_write
```

````

````{py:method} _do_write_backdoor(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item, map_info: pyuvm._reg.uvm_reg_map.uvm_reg_map_info) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg._do_write_backdoor
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._do_write_backdoor
```

````

````{py:method} _do_write_frontdoor(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item, map_info: pyuvm._reg.uvm_reg_map.uvm_reg_map_info) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg._do_write_frontdoor
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._do_write_frontdoor
```

````

````{py:method} do_read(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.do_read
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.do_read
```

````

````{py:method} _do_read_backdoor(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item, map_info: pyuvm._reg.uvm_reg_map.uvm_reg_map_info) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg._do_read_backdoor
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._do_read_backdoor
```

````

````{py:method} _do_read_frontdoor(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item, map_info: pyuvm._reg.uvm_reg_map.uvm_reg_map_info) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg._do_read_frontdoor
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._do_read_frontdoor
```

````

````{py:method} do_predict(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item, kind: pyuvm._reg.uvm_reg_model.uvm_predict_e, be: pyuvm._reg.uvm_reg_model.uvm_reg_byte_en_t = -1) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.do_predict

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.do_predict
```

````

````{py:method} set_frontdoor(ftdr: pyuvm._reg.uvm_reg_sequence.uvm_reg_frontdoor, map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None, fname: str = '', lineno: int = 0) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.set_frontdoor
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.set_frontdoor
```

````

````{py:method} get_frontdoor(map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None) -> pyuvm._reg.uvm_reg_sequence.uvm_reg_frontdoor
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_frontdoor
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_frontdoor
```

````

````{py:method} set_backdoor(bkdr: pyuvm._reg.uvm_reg_backdoor.uvm_reg_backdoor, fname: str = '', lineno: int = 0) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.set_backdoor
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.set_backdoor
```

````

````{py:method} get_backdoor(inherited: bool = True) -> pyuvm._reg.uvm_reg_backdoor.uvm_reg_backdoor
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_backdoor
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_backdoor
```

````

````{py:method} clear_hdl_path(kind: str = 'RTL') -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.clear_hdl_path
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.clear_hdl_path
```

````

````{py:method} add_hdl_path(slices: list[pyuvm._reg.uvm_reg_model.uvm_hdl_path_slice], kind: str = 'RTL') -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.add_hdl_path
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.add_hdl_path
```

````

````{py:method} add_hdl_path_slice(name: str, offset: int, size: int, first: bool = False, kind: str = 'RTL') -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.add_hdl_path_slice

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.add_hdl_path_slice
```

````

````{py:method} has_hdl_path(kind: str = '') -> bool
:canonical: pyuvm._reg.uvm_reg.uvm_reg.has_hdl_path
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.has_hdl_path
```

````

````{py:method} get_hdl_path(paths: list[pyuvm._reg.uvm_reg_model.uvm_hdl_path_concat], kind: str = '') -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_hdl_path
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_hdl_path
```

````

````{py:method} get_hdl_path_kind(kinds: list[str]) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_hdl_path_kind
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_hdl_path_kind
```

````

````{py:method} get_full_hdl_path(paths: list[pyuvm._reg.uvm_reg_model.uvm_hdl_path_concat], kind: str = '', separator: str = '.') -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_full_hdl_path
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_full_hdl_path
```

````

````{py:method} backdoor_read(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.backdoor_read
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.backdoor_read
```

````

````{py:method} backdoor_write(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.backdoor_write
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.backdoor_write
```

````

````{py:method} backdoor_read_func(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item) -> pyuvm._reg.uvm_reg_model.uvm_status_e
:canonical: pyuvm._reg.uvm_reg.uvm_reg.backdoor_read_func
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.backdoor_read_func
```

````

````{py:method} backdoor_watch() -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.backdoor_watch
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.backdoor_watch
```

````

````{py:method} include_coverage(scope: str, models: pyuvm._reg.uvm_reg_model.uvm_reg_cvr_t, accessor: pyuvm._s05_base_classes.uvm_object = None) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.include_coverage
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.include_coverage
```

````

````{py:method} build_coverage(models: pyuvm._reg.uvm_reg_model.uvm_reg_cvr_t) -> pyuvm._reg.uvm_reg_model.uvm_reg_cvr_t
:canonical: pyuvm._reg.uvm_reg.uvm_reg.build_coverage
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.build_coverage
```

````

````{py:method} add_coverage(models: pyuvm._reg.uvm_reg_model.uvm_reg_cvr_t) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.add_coverage
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.add_coverage
```

````

````{py:method} has_coverage(models: pyuvm._reg.uvm_reg_model.uvm_reg_cvr_t) -> bool
:canonical: pyuvm._reg.uvm_reg.uvm_reg.has_coverage
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.has_coverage
```

````

````{py:method} set_coverage(is_on: pyuvm._reg.uvm_reg_model.uvm_reg_cvr_t) -> pyuvm._reg.uvm_reg_model.uvm_reg_cvr_t
:canonical: pyuvm._reg.uvm_reg.uvm_reg.set_coverage
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.set_coverage
```

````

````{py:method} get_coverage(is_on: pyuvm._reg.uvm_reg_model.uvm_reg_cvr_t) -> bool
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_coverage
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_coverage
```

````

````{py:method} sample(data: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, byte_en: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, is_read: bool, map: pyuvm._reg.uvm_reg_map.uvm_reg_map) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.sample
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.sample
```

````

````{py:method} sample_values() -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.sample_values
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.sample_values
```

````

````{py:method} _sample(data: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, byte_en: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, is_read: bool, map: pyuvm._reg.uvm_reg_map.uvm_reg_map) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg._sample

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._sample
```

````

````{py:method} pre_write(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.pre_write
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.pre_write
```

````

````{py:method} post_write(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.post_write
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.post_write
```

````

````{py:method} pre_read(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.pre_read
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.pre_read
```

````

````{py:method} post_read(rw: pyuvm._reg.uvm_reg_item.uvm_reg_item) -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.post_read
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.post_read
```

````

````{py:method} get_reg_size() -> int
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_reg_size

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_reg_size
```

````

````{py:property} n_bits
:canonical: pyuvm._reg.uvm_reg.uvm_reg.n_bits
:type: int

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.n_bits
```

````

````{py:method} check_err_list() -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg.check_err_list

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.check_err_list
```

````

````{py:method} _set_lock() -> None
:canonical: pyuvm._reg.uvm_reg.uvm_reg._set_lock

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg._set_lock
```

````

````{py:method} set_desired(value)
:canonical: pyuvm._reg.uvm_reg.uvm_reg.set_desired

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.set_desired
```

````

````{py:method} get_desired()
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_desired

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_desired
```

````

````{py:method} get_access_policy()
:canonical: pyuvm._reg.uvm_reg.uvm_reg.get_access_policy

```{autodoc2-docstring} pyuvm._reg.uvm_reg.uvm_reg.get_access_policy
```

````

`````