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

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

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

## Module Contents

### Classes

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

* - {py:obj}`uvm_reg_data_t <pyuvm._reg.uvm_reg_model.uvm_reg_data_t>`
  -
* - {py:obj}`uvm_reg_data_logic_t <pyuvm._reg.uvm_reg_model.uvm_reg_data_logic_t>`
  -
* - {py:obj}`uvm_reg_addr_t <pyuvm._reg.uvm_reg_model.uvm_reg_addr_t>`
  -
* - {py:obj}`uvm_reg_addr_logic_t <pyuvm._reg.uvm_reg_model.uvm_reg_addr_logic_t>`
  -
* - {py:obj}`uvm_reg_byte_en_t <pyuvm._reg.uvm_reg_model.uvm_reg_byte_en_t>`
  -
* - {py:obj}`uvm_reg_cvr_t <pyuvm._reg.uvm_reg_model.uvm_reg_cvr_t>`
  -
* - {py:obj}`uvm_hdl_path_slice <pyuvm._reg.uvm_reg_model.uvm_hdl_path_slice>`
  -
* - {py:obj}`uvm_status_e <pyuvm._reg.uvm_reg_model.uvm_status_e>`
  -
* - {py:obj}`uvm_door_e <pyuvm._reg.uvm_reg_model.uvm_door_e>`
  -
* - {py:obj}`uvm_path_e <pyuvm._reg.uvm_reg_model.uvm_path_e>`
  -
* - {py:obj}`uvm_check_e <pyuvm._reg.uvm_reg_model.uvm_check_e>`
  -
* - {py:obj}`uvm_endianness_e <pyuvm._reg.uvm_reg_model.uvm_endianness_e>`
  -
* - {py:obj}`uvm_elem_kind_e <pyuvm._reg.uvm_reg_model.uvm_elem_kind_e>`
  -
* - {py:obj}`uvm_access_e <pyuvm._reg.uvm_reg_model.uvm_access_e>`
  -
* - {py:obj}`uvm_hier_e <pyuvm._reg.uvm_reg_model.uvm_hier_e>`
  -
* - {py:obj}`uvm_predict_e <pyuvm._reg.uvm_reg_model.uvm_predict_e>`
  -
* - {py:obj}`uvm_coverage_model_e <pyuvm._reg.uvm_reg_model.uvm_coverage_model_e>`
  -
* - {py:obj}`uvm_reg_mem_test_e <pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e>`
  -
* - {py:obj}`uvm_hdl_path_concat <pyuvm._reg.uvm_reg_model.uvm_hdl_path_concat>`
  -
* - {py:obj}`uvm_reg_backdoor <pyuvm._reg.uvm_reg_model.uvm_reg_backdoor>`
  -
* - {py:obj}`uvm_reg_frontdoor <pyuvm._reg.uvm_reg_model.uvm_reg_frontdoor>`
  - ```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_reg_frontdoor
    :summary:
    ```
* - {py:obj}`uvm_reg_map_addr_range <pyuvm._reg.uvm_reg_model.uvm_reg_map_addr_range>`
  - ```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_reg_map_addr_range
    :summary:
    ```
* - {py:obj}`uvm_object_string_pool <pyuvm._reg.uvm_reg_model.uvm_object_string_pool>`
  -
````

### Data

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

* - {py:obj}`__all__ <pyuvm._reg.uvm_reg_model.__all__>`
  - ```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.__all__
    :summary:
    ```
* - {py:obj}`UVM_DEFAULT_PATH <pyuvm._reg.uvm_reg_model.UVM_DEFAULT_PATH>`
  - ```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.UVM_DEFAULT_PATH
    :summary:
    ```
* - {py:obj}`UVM_REG_DATA_WIDTH <pyuvm._reg.uvm_reg_model.UVM_REG_DATA_WIDTH>`
  - ```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.UVM_REG_DATA_WIDTH
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: pyuvm._reg.uvm_reg_model.__all__
:value: >
   ['UVM_DEFAULT_PATH', 'UVM_REG_DATA_WIDTH', 'uvm_reg_data_t', 'uvm_reg_data_logic_t', 'uvm_reg_addr_t...

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

````

```{py:class} uvm_reg_data_t()
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_data_t

Bases: {py:obj}`int`

```

```{py:class} uvm_reg_data_logic_t()
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_data_logic_t

Bases: {py:obj}`int`

```

```{py:class} uvm_reg_addr_t()
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_addr_t

Bases: {py:obj}`int`

```

```{py:class} uvm_reg_addr_logic_t()
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_addr_logic_t

Bases: {py:obj}`int`

```

```{py:class} uvm_reg_byte_en_t()
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_byte_en_t

Bases: {py:obj}`int`

```

```{py:class} uvm_reg_cvr_t()
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_cvr_t

Bases: {py:obj}`int`

```

`````{py:class} uvm_hdl_path_slice(name='')
:canonical: pyuvm._reg.uvm_reg_model.uvm_hdl_path_slice

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

````{py:attribute} path
:canonical: pyuvm._reg.uvm_reg_model.uvm_hdl_path_slice.path
:type: str
:value: >
   None

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_hdl_path_slice.path
```

````

````{py:attribute} offset
:canonical: pyuvm._reg.uvm_reg_model.uvm_hdl_path_slice.offset
:type: int
:value: >
   None

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_hdl_path_slice.offset
```

````

````{py:attribute} size
:canonical: pyuvm._reg.uvm_reg_model.uvm_hdl_path_slice.size
:type: int
:value: >
   None

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_hdl_path_slice.size
```

````

`````

`````{py:class} uvm_status_e(*args, **kwds)
:canonical: pyuvm._reg.uvm_reg_model.uvm_status_e

Bases: {py:obj}`enum.Enum`

````{py:attribute} UVM_IS_OK
:canonical: pyuvm._reg.uvm_reg_model.uvm_status_e.UVM_IS_OK
:value: >
   0

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_status_e.UVM_IS_OK
```

````

````{py:attribute} UVM_NOT_OK
:canonical: pyuvm._reg.uvm_reg_model.uvm_status_e.UVM_NOT_OK
:value: >
   1

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_status_e.UVM_NOT_OK
```

````

````{py:attribute} UVM_HAS_X
:canonical: pyuvm._reg.uvm_reg_model.uvm_status_e.UVM_HAS_X
:value: >
   2

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_status_e.UVM_HAS_X
```

````

`````

`````{py:class} uvm_door_e(*args, **kwds)
:canonical: pyuvm._reg.uvm_reg_model.uvm_door_e

Bases: {py:obj}`enum.Enum`

````{py:attribute} UVM_FRONTDOOR
:canonical: pyuvm._reg.uvm_reg_model.uvm_door_e.UVM_FRONTDOOR
:value: >
   0

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_door_e.UVM_FRONTDOOR
```

````

````{py:attribute} UVM_BACKDOOR
:canonical: pyuvm._reg.uvm_reg_model.uvm_door_e.UVM_BACKDOOR
:value: >
   1

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_door_e.UVM_BACKDOOR
```

````

````{py:attribute} UVM_PREDICT
:canonical: pyuvm._reg.uvm_reg_model.uvm_door_e.UVM_PREDICT
:value: >
   2

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_door_e.UVM_PREDICT
```

````

````{py:attribute} UVM_DEFAULT_DOOR
:canonical: pyuvm._reg.uvm_reg_model.uvm_door_e.UVM_DEFAULT_DOOR
:value: >
   3

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_door_e.UVM_DEFAULT_DOOR
```

````

`````

```{py:class} uvm_path_e(*args, **kwds)
:canonical: pyuvm._reg.uvm_reg_model.uvm_path_e

Bases: {py:obj}`enum.Enum`

```

`````{py:class} uvm_check_e(*args, **kwds)
:canonical: pyuvm._reg.uvm_reg_model.uvm_check_e

Bases: {py:obj}`enum.Enum`

````{py:attribute} UVM_NO_CHECK
:canonical: pyuvm._reg.uvm_reg_model.uvm_check_e.UVM_NO_CHECK
:value: >
   0

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_check_e.UVM_NO_CHECK
```

````

````{py:attribute} UVM_CHECK
:canonical: pyuvm._reg.uvm_reg_model.uvm_check_e.UVM_CHECK
:value: >
   1

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_check_e.UVM_CHECK
```

````

`````

`````{py:class} uvm_endianness_e(*args, **kwds)
:canonical: pyuvm._reg.uvm_reg_model.uvm_endianness_e

Bases: {py:obj}`enum.Enum`

````{py:attribute} UVM_NO_ENDIAN
:canonical: pyuvm._reg.uvm_reg_model.uvm_endianness_e.UVM_NO_ENDIAN
:value: >
   0

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_endianness_e.UVM_NO_ENDIAN
```

````

````{py:attribute} UVM_LITTLE_ENDIAN
:canonical: pyuvm._reg.uvm_reg_model.uvm_endianness_e.UVM_LITTLE_ENDIAN
:value: >
   1

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_endianness_e.UVM_LITTLE_ENDIAN
```

````

````{py:attribute} UVM_BIG_ENDIAN
:canonical: pyuvm._reg.uvm_reg_model.uvm_endianness_e.UVM_BIG_ENDIAN
:value: >
   2

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_endianness_e.UVM_BIG_ENDIAN
```

````

````{py:attribute} UVM_LITTLE_FIFO
:canonical: pyuvm._reg.uvm_reg_model.uvm_endianness_e.UVM_LITTLE_FIFO
:value: >
   3

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_endianness_e.UVM_LITTLE_FIFO
```

````

````{py:attribute} UVM_BIG_FIFO
:canonical: pyuvm._reg.uvm_reg_model.uvm_endianness_e.UVM_BIG_FIFO
:value: >
   4

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_endianness_e.UVM_BIG_FIFO
```

````

`````

`````{py:class} uvm_elem_kind_e(*args, **kwds)
:canonical: pyuvm._reg.uvm_reg_model.uvm_elem_kind_e

Bases: {py:obj}`enum.Enum`

````{py:attribute} UVM_REG
:canonical: pyuvm._reg.uvm_reg_model.uvm_elem_kind_e.UVM_REG
:value: >
   0

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_elem_kind_e.UVM_REG
```

````

````{py:attribute} UVM_FIELD
:canonical: pyuvm._reg.uvm_reg_model.uvm_elem_kind_e.UVM_FIELD
:value: >
   1

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_elem_kind_e.UVM_FIELD
```

````

````{py:attribute} UVM_MEM
:canonical: pyuvm._reg.uvm_reg_model.uvm_elem_kind_e.UVM_MEM
:value: >
   2

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_elem_kind_e.UVM_MEM
```

````

`````

`````{py:class} uvm_access_e(*args, **kwds)
:canonical: pyuvm._reg.uvm_reg_model.uvm_access_e

Bases: {py:obj}`enum.Enum`

````{py:attribute} UVM_READ
:canonical: pyuvm._reg.uvm_reg_model.uvm_access_e.UVM_READ
:value: >
   0

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_access_e.UVM_READ
```

````

````{py:attribute} UVM_WRITE
:canonical: pyuvm._reg.uvm_reg_model.uvm_access_e.UVM_WRITE
:value: >
   1

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_access_e.UVM_WRITE
```

````

````{py:attribute} UVM_BURST_READ
:canonical: pyuvm._reg.uvm_reg_model.uvm_access_e.UVM_BURST_READ
:value: >
   2

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_access_e.UVM_BURST_READ
```

````

````{py:attribute} UVM_BURST_WRITE
:canonical: pyuvm._reg.uvm_reg_model.uvm_access_e.UVM_BURST_WRITE
:value: >
   3

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_access_e.UVM_BURST_WRITE
```

````

`````

`````{py:class} uvm_hier_e(*args, **kwds)
:canonical: pyuvm._reg.uvm_reg_model.uvm_hier_e

Bases: {py:obj}`enum.Enum`

````{py:attribute} UVM_NO_HIER
:canonical: pyuvm._reg.uvm_reg_model.uvm_hier_e.UVM_NO_HIER
:value: >
   0

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_hier_e.UVM_NO_HIER
```

````

````{py:attribute} UVM_HIER
:canonical: pyuvm._reg.uvm_reg_model.uvm_hier_e.UVM_HIER
:value: >
   1

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_hier_e.UVM_HIER
```

````

`````

`````{py:class} uvm_predict_e(*args, **kwds)
:canonical: pyuvm._reg.uvm_reg_model.uvm_predict_e

Bases: {py:obj}`enum.Enum`

````{py:attribute} UVM_PREDICT_DIRECT
:canonical: pyuvm._reg.uvm_reg_model.uvm_predict_e.UVM_PREDICT_DIRECT
:value: >
   0

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_predict_e.UVM_PREDICT_DIRECT
```

````

````{py:attribute} UVM_PREDICT_READ
:canonical: pyuvm._reg.uvm_reg_model.uvm_predict_e.UVM_PREDICT_READ
:value: >
   1

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_predict_e.UVM_PREDICT_READ
```

````

````{py:attribute} UVM_PREDICT_WRITE
:canonical: pyuvm._reg.uvm_reg_model.uvm_predict_e.UVM_PREDICT_WRITE
:value: >
   2

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_predict_e.UVM_PREDICT_WRITE
```

````

`````

`````{py:class} uvm_coverage_model_e(*args, **kwds)
:canonical: pyuvm._reg.uvm_reg_model.uvm_coverage_model_e

Bases: {py:obj}`enum.Enum`

````{py:attribute} UVM_NO_COVERAGE
:canonical: pyuvm._reg.uvm_reg_model.uvm_coverage_model_e.UVM_NO_COVERAGE
:value: >
   0

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_coverage_model_e.UVM_NO_COVERAGE
```

````

````{py:attribute} UVM_CVR_REG_BITS
:canonical: pyuvm._reg.uvm_reg_model.uvm_coverage_model_e.UVM_CVR_REG_BITS
:value: >
   1

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_coverage_model_e.UVM_CVR_REG_BITS
```

````

````{py:attribute} UVM_CVR_ADDR_MAP
:canonical: pyuvm._reg.uvm_reg_model.uvm_coverage_model_e.UVM_CVR_ADDR_MAP
:value: >
   2

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_coverage_model_e.UVM_CVR_ADDR_MAP
```

````

````{py:attribute} UVM_CVR_FIELD_VALS
:canonical: pyuvm._reg.uvm_reg_model.uvm_coverage_model_e.UVM_CVR_FIELD_VALS
:value: >
   4

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_coverage_model_e.UVM_CVR_FIELD_VALS
```

````

````{py:attribute} UVM_CVR_ALL
:canonical: pyuvm._reg.uvm_reg_model.uvm_coverage_model_e.UVM_CVR_ALL
:value: >
   None

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_coverage_model_e.UVM_CVR_ALL
```

````

`````

`````{py:class} uvm_reg_mem_test_e()
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e

Bases: {py:obj}`enum.IntEnum`

````{py:attribute} UVM_DO_REG_HW_RESET
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_REG_HW_RESET
:value: >
   1

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_REG_HW_RESET
```

````

````{py:attribute} UVM_DO_REG_BIT_BASH
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_REG_BIT_BASH
:value: >
   2

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_REG_BIT_BASH
```

````

````{py:attribute} UVM_DO_REG_ACCESS
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_REG_ACCESS
:value: >
   4

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_REG_ACCESS
```

````

````{py:attribute} UVM_DO_MEM_ACCESS
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_MEM_ACCESS
:value: >
   8

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_MEM_ACCESS
```

````

````{py:attribute} UVM_DO_SHARED_ACCESS
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_SHARED_ACCESS
:value: >
   16

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_SHARED_ACCESS
```

````

````{py:attribute} UVM_DO_MEM_WALK
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_MEM_WALK
:value: >
   32

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_MEM_WALK
```

````

````{py:attribute} UVM_DO_ALL_REG_MEM_TESTS
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_ALL_REG_MEM_TESTS
:value: >
   18446744073709551615

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_reg_mem_test_e.UVM_DO_ALL_REG_MEM_TESTS
```

````

`````

```{py:class} uvm_hdl_path_concat(name: str = '')
:canonical: pyuvm._reg.uvm_reg_model.uvm_hdl_path_concat

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

```

```{py:class} uvm_reg_backdoor(name: str = '')
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_backdoor

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

```

````{py:class} uvm_reg_frontdoor()
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_frontdoor

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_reg_frontdoor
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_reg_frontdoor.__init__
```

````

````{py:class} uvm_reg_map_addr_range()
:canonical: pyuvm._reg.uvm_reg_model.uvm_reg_map_addr_range

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_reg_map_addr_range
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.uvm_reg_map_addr_range.__init__
```

````

```{py:class} uvm_object_string_pool(name: str = '')
:canonical: pyuvm._reg.uvm_reg_model.uvm_object_string_pool

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

```

````{py:data} UVM_DEFAULT_PATH
:canonical: pyuvm._reg.uvm_reg_model.UVM_DEFAULT_PATH
:type: pyuvm._reg.uvm_reg_model.uvm_door_e
:value: >
   None

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.UVM_DEFAULT_PATH
```

````

````{py:data} UVM_REG_DATA_WIDTH
:canonical: pyuvm._reg.uvm_reg_model.UVM_REG_DATA_WIDTH
:type: int
:value: >
   64

```{autodoc2-docstring} pyuvm._reg.uvm_reg_model.UVM_REG_DATA_WIDTH
```

````